GTFS segments
Project description
Table of Contents
About The Project
Transit agencies use the General Transit Feed Specification (GTFS) to publish transit data. More and more cities across the globe are adopting this GTFS format to represent their transit network. The GTFS feed can be downloaded from @transitfeeds and @mobility data. The GTFS segments is a concise representation of GTFS files removing unnecessary repetitions in the data. We do that by considering the services offered only the busiest day(in the data) and representing data in the form of segements.
Getting Started
Prerequisites
The major dependencies of this library are the following packages.
- numpy
- shapely
- pandas
- geopandas
- partridge
- matplotlib
- contextily
The detailed list of package dependencies can be found in requirements.txt
Installation
Option A
Use pip to install the package. Windows users may have to download and install Microsoft Visual C++ distributions. Follow these instructions.
pip install gtfs-segments
Option B
- Clone the repo
git clone https://github.com/UTEL-UIUC/gtfs_segments.git
- Install geopandas using the following code. Read more here
conda create -n geo_env conda activate geo_env conda config --env --add channels conda-forge conda config --env --set channel_priority strict conda install python=3 geopandas
- [Optional] Download modified version of
partridge
library and install it manually.git clone https://github.com/praneethd7/partridge cd partridge python setup.py install
- Install requirements using
pip install -r requirements.txt
- Install the
gtfs_segments
packagecd gtfs_segments python setup.py install
Usage
For documentation, please refer to the Documentation
Import the package using
import gtfs_segments
Get GTFS Files
Fetch all sources
from gtfs_segments import fetch_gtfs_source
sources_df = fetch_gtfs_source()
sources_df.head()
Fetch source by name/provider/state
from gtfs_segments import fetch_gtfs_source
sources_df = fetch_gtfs_source(place ='Chicago')
sources_df
Automated Download
from gtfs_segments import download_latest_data
download_latest_data(sources_df,"output_folder")
Manual Download
Download the GTFS .zip
files from @transitfeeds or @mobility data.
Get GTFS Segments
from gtfs_segments import get_gtfs_segments
segments_df = get_gtfs_segments("path_to_gtfs_zip_file")
segments_df
Visualize Spacings
from gtfs_segments import view_spacings
view_spacings(segments_df,route = '18131',segment = '6294-6290-1',basemap=True)
Plot Distributions
from gtfs_segments import plot_hist
plot_hist(segments_df, max_spacing = 1200)
Optionally save figure using
plot_hist(segments_df,file_path = "spacings_hist.png",save_fig = True)
Get Summary Stats
from gtfs_segments import summary_stats
summary_stats(segments_df,max_spacing = 3000,export = True,file_path = "summary.csv")
Download Data
Download the data as either .csv
or .geojson
from gtfs_segments import export_segments
export_segments(segments_df,'filename', output_format ='geojson')
# Get csv without geometry
export_segments(segments_df,'filename', output_format ='csv',geometry = False)
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Citing gtfs-segments
If you use gtfs-segments in your research please use the following BibTeX entry:
@Misc{gtfs_segments,
author = {Devunuri, Saipraneeth},
title = {gtfs-segments - A fast and efficient library to generate bus stop spacings},
howpublished = {Github},
year = {2022},
url = {https://github.com/UTEL-UIUC/gtfs_segments}
}
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Contact
Saipraneeth Devunuri - @praneethDevunu1 - sd37@illinois.edu
Project Link: https://github.com/UTEL-UIUC/gtfs_segments
Acknowledgments
- Parts of the code use the Partridge library
- Shoutout to Mobility Data for compiling GTFS from around the globe and constantly maintaining them
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for gtfs_segments-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a75b847b8ac9e7a50fac3803752379ca7087b3bd1a93f17565c319b1a61ae9de |
|
MD5 | 62576aaca9f6b29ae86118804f058034 |
|
BLAKE2b-256 | 08c94df5fcea4962e082c99b8dc5e6194513bb65cd23488d3193b9661db50de6 |