Merge pull request #21 from naviqore/NAV-170-Implementation-StopTimes…

…Array-erkl-ren Very intermediate DRAFT PR
naviqore · Sep 21, 2024 · 8351014 · 8351014
2 parents 28a843e + 9c31f06
commit 8351014
Show file tree

Hide file tree

Showing 39 changed files with 921 additions and 110 deletions.
diff --git a/Writerside/d.tree b/Writerside/d.tree
@@ -3,7 +3,7 @@
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
 
 <instance-profile id="d"
-                  name="Naviqore"
+                  name="Naviqore - Efficient Public Transit Routing with RAPTOR"
                   start-page="introduction.md">
 
     <toc-element topic="introduction.md"/>
@@ -31,6 +31,8 @@
         <toc-element topic="sequence-diagram.md"/>
     </toc-element>
     <toc-element topic="implementation.md">
+        <toc-element topic="gtfs-schedule.md"/>
+        <toc-element topic="public-transit-service.md"/>
         <toc-element topic="simple-raptor.md"/>
         <toc-element topic="extended-raptor.md"/>
         <toc-element topic="raptor-xx.md"/>
@@ -41,5 +43,5 @@
         <toc-element topic="limitations.md"/>
     </toc-element>
     <toc-element topic="conclusion-and-outlook.md"/>
-    <toc-element topic="References.md"/>
+    <toc-element topic="references.md"/>
 </instance-profile>
diff --git a/Writerside/images/boxplot_processing_time.png b/Writerside/images/boxplot_processing_time.png
diff --git a/Writerside/images/stop-times-array.png b/Writerside/images/stop-times-array.png
diff --git a/Writerside/images/success_rates.png b/Writerside/images/success_rates.png
diff --git a/Writerside/topics/analysis.md → Writerside/topics/analysis/analysis.md b/Writerside/topics/analysis.md → Writerside/topics/analysis/analysis.md
diff --git a/Writerside/topics/domain-model.md → Writerside/topics/analysis/domain-model.md b/Writerside/topics/domain-model.md → Writerside/topics/analysis/domain-model.md
diff --git a/Writerside/topics/domain.md → Writerside/topics/analysis/domain/domain.md b/Writerside/topics/domain.md → Writerside/topics/analysis/domain/domain.md
diff --git a/Writerside/topics/gtfs.md → Writerside/topics/analysis/domain/gtfs.md b/Writerside/topics/gtfs.md → Writerside/topics/analysis/domain/gtfs.md
diff --git a/Writerside/topics/raptor.md → Writerside/topics/analysis/domain/raptor.md b/Writerside/topics/raptor.md → Writerside/topics/analysis/domain/raptor.md
diff --git a/Writerside/topics/glossary.md → Writerside/topics/analysis/glossary.md b/Writerside/topics/glossary.md → Writerside/topics/analysis/glossary.md
@@ -7,19 +7,20 @@ different meanings depending on the layer or package they are associated with, e
 
 ## Public Transit
 
-| Term          | Description                                                                                                                        |
-|---------------|------------------------------------------------------------------------------------------------------------------------------------|
-| Agency        | An organization providing transit services.                                                                                        |
-| Connection    | An option for travel that include details like fare and possible routes and transfers                                              |
-| Leg           | A part of a connection in one mode of transportation or vehicle.                                                                   |
-| Journey       | A connection is realized as a journey when the passenger selects it and begins traveling.                                          |
-| Services      | Transit offerings by agencies, consisting of trips operating on specific routes.                                                   |
-| Stop          | A location where passengers board or alight from transit vehicles.                                                                 |
-| Schedule      | The planned timetable for transit services, detailing stops, routes, and times.                                                    |
-| Transfer      | A switch between different routes or a footpath between two stops.                                                                 |
-| Stop facility | Physical infrastructure where passengers wait and board transit vehicles.                                                          |
-| Station       | A station is a large stop facility, typically serving rail. It can also consist multiple smaller stop facilities (e.g. platforms). |
-| Platform      | A platform is a designated area within a station where passengers wait to board or alight from transit vehicles.                   |
+| Term          | Description                                                                                                                                  |
+|---------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| Agency        | An organization providing transit services.                                                                                                  |
+| Connection    | An option for travel that include details like fare and possible routes and transfers                                                        |
+| Leg           | A part of a connection in one mode of transportation or vehicle.                                                                             |
+| Journey       | A connection is realized as a journey when the passenger selects it and begins traveling.                                                    |
+| Services      | Transit offerings by agencies, consisting of trips operating on specific routes.                                                             |
+| Stop          | A location where passengers board or alight from transit vehicles.                                                                           |
+| Schedule      | The planned timetable for transit services, detailing stops, routes, and times.                                                              |
+| Transfer      | A switch between different routes or a footpath between two stops.                                                                           |
+| Stop facility | Physical infrastructure where passengers wait and board transit vehicles.                                                                    |
+| Station       | A station is a large stop facility, typically serving rail. It can also consist multiple smaller stop facilities (e.g. platforms).           |
+| Platform      | A platform is a designated area within a station where passengers wait to board or alight from transit vehicles.                             |
+| Isolines      | Reachable stops within a time frame, forming accessibility boundaries from a source stop, exploring routes without a predefined destination. |
 
 ## RAPTOR
 

diff --git a/Writerside/topics/requirements.md → Writerside/topics/analysis/requirements.md b/Writerside/topics/requirements.md → Writerside/topics/analysis/requirements.md
diff --git a/Writerside/topics/use-case.md → Writerside/topics/analysis/use-case.md b/Writerside/topics/use-case.md → Writerside/topics/analysis/use-case.md
@@ -38,4 +38,3 @@ accessibility of a region, and assessing alternative routes available at the tim
 
 Transit **agencies** publish GTFS schedules, which are then consumed by the service to provide up-to-date public transit
 information and connections.
-
diff --git a/Writerside/topics/benchmarking.md b/Writerside/topics/benchmarking.md
diff --git a/Writerside/topics/architectural-overview.md → ...e/topics/design/architectural-overview.md b/Writerside/topics/architectural-overview.md → ...e/topics/design/architectural-overview.md
diff --git a/Writerside/topics/c4-model.md → Writerside/topics/design/c4-model.md b/Writerside/topics/c4-model.md → Writerside/topics/design/c4-model.md
diff --git a/Writerside/topics/design.md → Writerside/topics/design/design.md b/Writerside/topics/design.md → Writerside/topics/design/design.md
diff --git a/Writerside/topics/sequence-diagram.md → Writerside/topics/design/sequence-diagram.md b/Writerside/topics/sequence-diagram.md → Writerside/topics/design/sequence-diagram.md
@@ -10,10 +10,11 @@ URL. While running the service periodically updates the **GTFS Static** schedule
 
 ```mermaid
 sequenceDiagram
-    participant Admin
+    participant Admin #LightSkyBlue
     participant SpringApp as Spring Application (REST API)
     participant Service as Public Transit Service
-    participant GTFS
+    participant GTFS #LightCoral
+    participant RAPTOR #LightCoral
     participant Schedule as GTFS Static
 
     Admin ->>+ SpringApp: Start
@@ -22,6 +23,10 @@ sequenceDiagram
     GTFS ->>+ Schedule: Fetch
     Schedule -->>- GTFS: Return data
     GTFS -->>- Service: Schedule in memory
+    
+    Service ->>+ RAPTOR: Initialize
+    RAPTOR -->>- Service: RAPTOR data structure in memory
+
     Service -->>- SpringApp: Ready
 
     loop Periodic GTFS Static Reload
@@ -30,6 +35,8 @@ sequenceDiagram
         GTFS ->>+ Schedule: Fetch new version
         Schedule -->>- GTFS: Return updated data
         GTFS -->>- Service: New schedule in memory
+        Service ->>+ RAPTOR: Initialize (and clear trip mask cache)
+        RAPTOR -->>- Service: New RAPTOR data structure in memory
         Service -->>- SpringApp: Update complete
     end
    

diff --git a/Writerside/topics/extended-raptor.md b/Writerside/topics/extended-raptor.md
diff --git a/Writerside/topics/implementation.md b/Writerside/topics/implementation.md