TIDES-transit / TIDES

Transit ITS Data Exchange Specification for historical transit operations data
https://tides-transit.github.io/TIDES
Apache License 2.0
28 stars 4 forks source link
open-standards transit

TIDES

TIDES is the Transit ITS Data Exchange Specification and is your key to accessing, managing, and using transit operations data.

Why TIDES?

TIDES is a data specification for transit operations data including vehicle location data, passenger count data, and fare transaction data.

TIDES frees your transit data and gives you more options to turn operations data into information on ridership, passenger loads, fare revenue, vehicle speed and delay, service reliability, and more!

TIDES is open-source, free for use, and is community governed, developed and supported. This repository provides data schemas and tools to support the access, management, and improvement of historical transit operations data, including vehicle operations, passenger activity, fare collection, and other similar data.

TIDES specification

The TIDES specification is maintained in the /spec sub-directory as a series of JSON tables compatible with the frictionless table schema standards. Human-friendlier documentation is auto-generated and available at:

Data Package

Directories with TIDES data must contain metadata in a datapackage.json file in a format compliant with the tides-datapackage-profile of a frictionless data package.

/samples/template/datapackage.json has a template datapackage which can be used.

Sample Data

Sample data can be found in the /samples directory, with one directory for each sample.

Template

Templates of datapackage.json and each TIDES file type are located in the /samples/template directory.

Validating TIDES data

TIDES data with a valid datapackage.json can be easily validated using the frictionless framework, which can be installed and invoked as follows:

pip install frictionless
frictionless validate --schema-sync path/to/your/datapackage.json

Several other validation scripts and tools with more flexibility such as validating to the canonical, named version or a local spec can be found in the /bin directory, with usage available with the --help flag.

bin/validate-datapackage [-v remote_spec_ref | -l local_spec_path] [-d dataset_path]

Contributing to TIDES

Those who want to help with the development of the TIDES specification should review the guidance in contributing.

Issues

Please add issues, bugs, and feature requests to GitHub.

Acknowledgment

These data schemas and tool definitions developed here are based on the results of research conducted by the Transportation Research Board (TRB) of the National Academies of Science, Engineering, and Medicine (NASEM) under the Transit Cooperative Research Program (TCRP). This research is available at the National Academies website.

Note that neither the TIDES Project nor the TIDES-transit repository are associated with TCRP, TRB, or the Academies. The use of the TCRP research results in this repository do not reflect any explicit or implicit endorsement of or participation in this work by the Academies. In addition, the opinions and conclusions expressed or implied in the research are those of the contractor. They are not necessarily those of the Transportation Research Board, the Academies, or the program sponsors.