Metadata-Version: 2.1
Name: gtfs_railways
Version: 0.1.6
Summary: Functions to work on GTFS railway data
Home-page: https://github.com/DT-Service-Consulting/gtfs_railways
Author: Renzo Massobrio
Author-email: renzo.massobrio@uantwerpen.be
Maintainer: Marco Di Gennaro, Praneesh Sharma
Maintainer-email: marco.digennaro@dtsc.be, praneesh.sharma@dtsc.be
Project-URL: Homepage, https://github.com/DT-Service-Consulting/gtfs_railways
Project-URL: Repository, https://github.com/DT-Service-Consulting/gtfs_railways
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: bokeh
Requires-Dist: networkx
Requires-Dist: matplotlib
Requires-Dist: geopy
Requires-Dist: thefuzz
Requires-Dist: ipython
Requires-Dist: pytest
Requires-Dist: pytest-cov
Requires-Dist: scipy

# GTFS Railways

`gtfs-railways` is a Python package designed to analyze and simulate railway networks based on GTFS (General Transit Feed Specification) data stored in SQLite databases. It provides tools for network efficiency simulations, node removal strategies, and visualization of results.

## Features

- Load GTFS data from SQLite databases  
- Compute network efficiency metrics  
- Simulate the impact of node removals (random, targeted, betweenness-based)  
- Visualize efficiency results with customizable plots  
- Utilities for working with railway transit data  

## Installation

Install the package from PyPI using pip:

```bash
pip install gtfs-railways
```

In its current state, the package requires some external packages to be installed manually. 
You can install them using pip as follows:

```bash
pip gtfs_railways/external_packages/osmread
pip gtfs_railways/external_packages/gtfspy
```

## Examples

- **example_01.py**
  - Minimal working example of the P-space function.
    The P-space is the ensemble of all possible paths in the railway network.


- **example_02.py**
  - Minimal working example of the GTC function.
    GTC is the computational cost to the calculation of all connections between two nodes in the P-space.

    The travel cost is the calculation of all possible paths between any two nodes in the P-space.


- **example_03.py**
  - Minimal working example of the efficiency_graph function.
    The efficiency_graph function has been optimized (version 0 to 5).


- **example_04.py**
   - Minimal working example of the nodes removal simulation on a single graph.
