Metadata-Version: 2.4
Name: gtfs2gmns
Version: 0.8.0
Summary: Convert GTFS transit data to GMNS (General Modeling Network Specification) network files.
Author: gtfs2gmns contributors
License-Expression: MIT
Keywords: gtfs,gmns,transit,transportation,network
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: pandas
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"

# GTFS2GMNS

The open-source Python codes (GTFS2GMNS) is released to facilitate researchers and planners to construct the multi-modal transit networks easily from generic [General Transit Feed Specification (GTFS)](https://gtfs.org/) to the network modeling format in [General Modeling Network Specification (GMNS)](https://github.com/zephyr-data-specs/GMNS). The converted physical and service networks in GMNS format are more convenient for network modeling tasks such as transit network routing, traffic flow assignment, simulation and service network optimization.

Your comments will be valuable for code review and improvement. Please feel free to add your comments to our Google document of [GTFS2GMNS Users' Guide](https://docs.google.com/document/d/1-A2g4ZjJu-gzusEKcSoOXzr95S3tv7sj/edit?usp=sharing&ouid=112385243549486266715&rtpof=true&sd=true).


## Getting Started

#### *1. Download GTFS Data*

On TransitFeed [homepage](https://transitfeeds.com/), users can browse and download official GTFS  feeds from around the world. Make sure that the following files are present, so that we can proceed.

* stop.txt
* route.txt
* trip.txt
* stop_times.txt
* agency.txt
 
GTFS2GMNS can handle the transit data from several agencies. Users need to configure different sub-files in the same directory. Under the `test` folder, three subfolders `Cottonwood_Area_Transit`, `Flagstaff_MountainLine`, and `Sedona_RoadRunner` with their owm GTFS data is set up.

#### *Convert GTFS Data into GMNS Format*

#### *2. Read GTFS data*

**Step 2.1: Read routes.txt**

- route_id, route_long_name, route_short_name, route_url, route_type

**Step 2.2: Read stop.txt**

- stop_id, stop_lat, stop_lon, direction, location_type, position, stop_code, stop_name, zone_id

**Step 2.3: Read trips.txt**

- trip_id, route_id, service_id, block_id, direction_id, shape_id, trip_type
- and create the directed_route_id by combining route_id and direction_id

**Step 2.4: Read stop_times.txt**

- trip_id, stop_id, arrival_time, deaprture_time, stop_sequence

- create directed_route_stop_id by combining directed_route_id and stop_id through the trip_id

  > Note: the function needs to skip this record if trip_id is not defined, and link the virtual stop id with corresponding physical stop id.

- fetch the geometry of the direction_route_stop_id

- return the arrival_time for every stop

#### *3. Building service network*

**Step 3.1 Create physical nodes**

- physical node is the original stop in standard GTFS

**Step 3.2 Create directed route stop vertexes**

- add route stop vertexes. the node_id of route stop nodes starts from 100001

  > Note: the route stop vertex the programing create nearby the corresponding physical node, to make some offset.

- add entrance link from physical node to route stop node
- add exit link from route stop node to physical node. As they both connect to the physical nodes, the in-station transfer process can be also implemented

**Step 3.3 Create boarding and decoarding arcs**

- add links between each physical node and corresponding route stop vertexes.

**Step 3.4 Create transferring arcs**

- add transferring links between physical nodes of different mode.

**Step 3.5 Create service arcs**

- add service links between each route stop pair of each trip


#### *4. Output*

The output files include node.csv and link.csv.


#### *5. Visualization*

You can visualize generated networks using [NeXTA](https://github.com/xzhou99/NeXTA-GMNS) or [QGIS](https://qgis.org/).


