|
1 | 1 | # Mobility Data Specification |
2 | 2 |
|
3 | | -The Mobility Data Specification (**MDS**) is a set of data specifications and data sharing requirements focused on dockless e-scooters, bicycles and carshare. Inspired by [GTFS](https://developers.google.com/transit/gtfs/reference/) and [GBFS](https://github.com/NABSA/gbfs) the goals of the MDS are to provide API and data standards for municipalities to help ingest, compare and analyze *mobility as a service* provider data. |
| 3 | +The Mobility Data Specification (**MDS**), a project of the [Open Mobility Foundation](http://www.openmobilityfoundation.org) (OMF), is a set of Application Programming Interfaces (APIs) focused on dockless e-scooters, bicycles and carshare. Inspired by projects like [GTFS](https://developers.google.com/transit/gtfs/reference/) and [GBFS](https://github.com/NABSA/gbfs), the goals of MDS are to provide a standardized way for municipalities or other regulatory agencies to ingest, compare and analyze data from mobility service providers, and to give municipalities the ability to express regulation in machine-readable formats. |
4 | 4 |
|
5 | | -The **MDS** helps the City ingest and analyze information from for-profit companies who operate dockless scooters, bicycles and carshare in the public right-of-way. MDS is a key piece of digital infrastructure that helps cities and regulators such as Los Angeles Department of Transportation (LADOT) understand how dockless mobility operate. |
| 5 | +**MDS** helps cities interact with companies who operate dockless scooters, bicycles and carshare in the public right-of-way. MDS is a key piece of digital infrastructure that supports the effective implementation of mobility policies in cities around the world. |
6 | 6 |
|
7 | | -Mobility providers are required to share data with LADOT as part of the City of Los Angeles' Dockless Mobility Permit. Standardizing data collection between different providers improves cooperation, innovation, and efficiency of the City's transportation network. |
| 7 | +**MDS** is an open-source project. It was originally created by the [Los Angeles Department of Transportation](http://ladot.io) (LADOT). In November 2019, stewardship of MDS and the ownership of this repository was transferred to the Open Mobility Foundation. GitHub automatically redirects any links to this repository in the `CityOfLosAngeles` organization to the `openmobilityfoundation` instead. MDS continues to be used by LADOT and many other municipalities. |
8 | 8 |
|
9 | 9 | **MDS** is currently comprised of three distinct components: |
10 | 10 |
|
11 | | -* The [`provider`][provider] Application Program Interface (API) was first released May 2018 to be implemented by mobility providers. When a municipality queries information from a mobility provider, the Provider API has a historical view of operations in a standard format. |
| 11 | +* The [`provider`][provider] API endpoints are intended to be implemented by mobility providers and consumed by regulatory agencies. When a municipality queries information from a mobility provider, the Provider API has a historical view of operations in a standard format. It was first released in June 2018. Development takes place under the guidance of the OMF's Provider Services Working Group. |
12 | 12 |
|
13 | | -* The [`agency`][agency] API was first released in April 2019 to be implemented by regulatory agencies. The first implementation went live in Febuary 2019. Providers query the Agency API when an event occurs, like a trip starting or ending. |
| 13 | +* The [`agency`][agency] API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Agency API when events (such as a trip start or vehicle status change) occur in their systems. It was first released in April 2019. Development takes place under the guidance of the OMF's City Services Working Group. |
14 | 14 |
|
15 | | -* The [`policy`][policy] specification was first released in October 2019 to be implemented by regulatory agencies. Providers query Policy endpoints to obtain machine-readable regulatory rules that can be used to evaluate compliance with Agency policy. |
| 15 | +* The [`policy`][policy] API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about local rules that may affect the operation of their mobility service or which may be used to determine compliance. It was first released in October 2019. Development takes place under the guidance of the OMF's City Services Working Group. |
16 | 16 |
|
17 | | -Cities and regulators can choose how best to implement *Agency*, *Provider*, and/or *Policy* either separately, concurrently, or by endpoint. |
| 17 | +MDS is designed to be a modular kit-of-parts. Regulatory agencies can use the components of the API that are appropriate for their needs. An agency may choose to use only `agency`, `provider`, or `policy`. Or they may select specific elements (endpoints) from each to help them implement their goals. |
18 | 18 |
|
19 | 19 | ## Learn More / Get Involved / Contributing |
| 20 | +To stay up to date on MDS releases, meetings, and events, please **subscribe to the [mds-announce](https://groups.google.com/a/groups.openmobilityfoundation.org/forum/#!forum/mds-announce) mailing list.** |
20 | 21 |
|
21 | | -* To stay up to date on MDS releases and planning calls, please subscribe to the [MDS-Announce](https://groups.google.com/forum/#!forum/mds-announce) mailing list. |
22 | | -* You can view info about past releases and planning calls in the [wiki](https://github.com/CityOfLosAngeles/mobility-data-specification/wiki). |
23 | | -* To understand the contributing guidelines review the [CONTRIBUTING page.](CONTRIBUTING.md) |
24 | | -* To learn more about MDS and other related projects, including LADOT's Technology Action Plan, visit [ladot.io.](https://ladot.io/) |
| 22 | +The Mobility Data Specification is an open source project with all development taking place on GitHub. Comments and ideas can be shared by [creating an issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues), and specific changes can be suggested by [opening a pull request](https://github.com/openmobilityfoundation/mobility-data-specification/pulls). Before contributing, please review our [CONTRIBUTING page](CONTRIBUTING.md) to understand guidelines and policies for participation and our [CODE OF CONDUCT page](CODE_OF_CONDUCT.md). |
25 | 23 |
|
26 | | -For questions about MDS please contact [ladot.innovation@lacity.org](mailto:ladot.innovation@lacity.org). |
| 24 | +You can also get involved in development by joining an OMF working group. The working groups maintain the OMF GitHub repositories and work through issues and pull requests. Each working group has its own mailing list for non-technical discussion and planning: |
| 25 | + |
| 26 | +Working Group | Mailing List | Description |
| 27 | +--- | --- | --- |
| 28 | +Provider Services | [mds-provider-services](https://groups.google.com/a/groups.openmobilityfoundation.org/forum/#!forum/mds-provider-services) | Manages the [`provider`][provider] API within MDS. |
| 29 | +City Services | [mds-city-services](https://groups.google.com/a/groups.openmobilityfoundation.org/forum/#!forum/mds-city-services) | Manages the [`agency`][agency] and [`policy`][policy] APIs within MDS, as well as the [`mds-core`](https://github.com/openmobilityfoundation/mds-core) reference implementation. |
| 30 | + |
| 31 | +You can view info about past releases and planning calls in the [wiki](https://github.com/openmobilityfoundation/mobility-data-specification/wiki). |
| 32 | + |
| 33 | + |
| 34 | +For questions about MDS please contact [info@openmobilityfoundation.org](mailto:info@openmobilityfoundation.org). Media inquiries to [media@openmobilityfoundation.org](mailto:media@openmobilityfoundation.org) |
27 | 35 |
|
28 | 36 | ## Versions |
29 | 37 |
|
30 | | -The specification will be versioned using Git tags and [semantic versioning](https://semver.org/). See prior [releases](https://github.com/CityOfLosAngeles/mobility-data-specification/releases) and the [Release Guidelines](ReleaseGuidelines.md) for more information. |
| 38 | +The specification will be versioned using Git tags and [semantic versioning](https://semver.org/). See prior [releases](https://github.com/openmobilityfoundation/mobility-data-specification/releases) and the [Release Guidelines](ReleaseGuidelines.md) for more information. |
31 | 39 |
|
32 | 40 | Information about the latest release and all releases are below. Please note, you may be viewing a development copy of the Mobility Data Specification based on the current branch. Info about the latest release and all releases is below. |
33 | 41 |
|
34 | | -* [Latest Release](https://github.com/CityOfLosAngeles/mobility-data-specification/tree/master) |
| 42 | +* [Latest Release](https://github.com/openmobilityfoundation/mobility-data-specification/tree/master) |
35 | 43 |
|
36 | | -* [All Releases](https://github.com/CityOfLosAngeles/mobility-data-specification/releases) |
| 44 | +* [All Releases](https://github.com/openmobilityfoundation/mobility-data-specification/releases) |
37 | 45 |
|
38 | | -## Cities Using MDS |
| 46 | +## Cities Using MDS |
39 | 47 |
|
40 | | -The Mobility Data Specification is an Open Source project. Comments can be made by making an Github Issue, while suggested changes can be made using a pull request. Many cities and operators have implemented MDS, more details about their specific programs can be found below. |
| 48 | +More than 80 cities and public agencies around the world use MDS, and it has been implemented by most major mobility providers. Below are links to some specific agency programs/policies: |
41 | 49 |
|
42 | 50 | * Los Angeles: The rules and guidelines for the Los Angeles Dockless Bikeshare Systems / Pilot Program can be found on [Council Clerk Connect](https://cityclerk.lacity.org/lacityclerkconnect/index.cfm?fa=ccfi.viewrecord&cfnumber=17-1125) along with supporting info on [ladot.io](https://ladot.io/programs/dockless/). |
43 | 51 | * Santa Monica: The rules and guidelines for the Santa Monica Shared Mobility Pilot Program can be found at https://www.smgov.net/sharedmobility. |
44 | 52 | * Austin: The rules and guidelines for Austin's Micromobility Program can be found at https://austintexas.gov/micromobility. |
45 | 53 | * Ulm: A draft of the guidelines can be found at [the city's GitHub presence](https://github.com/stadtulm/mds-zonen). |
46 | | - |
47 | | -[Add your City here by opening a pull request](https://github.com/CityofLosAngeles/mobility-data-specification/compare) |
| 54 | +* _[add your City here by opening a pull request](https://github.com/openmobilityfoundation/mobility-data-specification/compare)_ |
48 | 55 |
|
49 | 56 | ## Use Cases |
50 | | -MDS enables cities to: |
| 57 | +Some examples of how cities are using MDS in practice: |
51 | 58 |
|
52 | 59 | - Verify how many scooters are operating. |
53 | | -- Verify whether scooters are being deployed equitably across neighborhoods. |
54 | | -- Determine whether scooters are dropped off outside of a service area. |
| 60 | +- Verify whether scooters are being deployed equitably across neighborhoods. |
| 61 | +- Determine whether scooters are dropped off outside of a service area. |
55 | 62 | - Determine whether scooters are being parked in safe and appropriate parking areas. |
56 | | -- Ensure compliance with Device Caps, Operating Regulations. |
57 | | -- Ensure inform and help manage 311 / Service Request style operations. |
| 63 | +- Ensure compliance with device caps and operating regulations. |
| 64 | +- Ensure inform and help manage 311 / Service Request style operations. |
58 | 65 | - Inform future capital investments such as dockless vehicle drop zones or furniture zones. |
59 | | -- Inform policy making – number of scooters, distribution, etc. |
| 66 | +- Inform infrastructure planning efforts such as the addition of bike lanes or street redesigns. |
| 67 | +- Provide visibility into the relationship between micromobility and other modes, such as public transit |
| 68 | +- Inform micromobility policy making – number of scooters, distribution, etc. |
60 | 69 | - Develop ways to communicate dynamic information on unplanned events, such as emergency road closures, water main breaks, etc. to mobility providers to help them keep their users and contractors informed for better route planning and re-balancing efforts. |
61 | | -- Much More! |
62 | 70 |
|
63 | 71 | ## Related Projects |
64 | 72 |
|
| 73 | +### Open Mobility Foundation |
| 74 | +* [`mds-core`](https://github.com/openmobilityfoundation/mds-core) - A reference implementation of an MDS Agency Server, built using PostgresQL, TypeScript, NodeJS. |
| 75 | +* [`mds-compliance-mobile`](`https://github.com/openmobilityfoundation/mds-compliance-mobile`) - A mobile app for performing in-the-field data validation and compliance monitoring. |
| 76 | + |
65 | 77 | ### City of Los Angeles |
66 | | -* [`mds-dev`](https://github.com/cityoflosangeles/mds-dev) - Code to do cap checking, fake data generation and more with provider data. |
67 | | -* [`mds-validator`](https://github.com/cityoflosangeles/mds-validator) - Code to validate MDS APIs using JSONSchema. |
68 | | -* [`aqueduct`](https://github.com/cityoflosangeles/aqueduct) - ETL, Data Warehousing, and Machine Learning Platform for LA City Data Science team. Handles extracting MDS provider APIs and storing in data warehouse. |
| 78 | +* [`mds-dev`](https://github.com/cityoflosangeles/mds-dev) - Code to do cap checking, fake data generation and more with provider data. |
| 79 | +* [`mds-validator`](https://github.com/cityoflosangeles/mds-validator) - Code to validate MDS APIs using JSONSchema. |
| 80 | +* [`aqueduct`](https://github.com/cityoflosangeles/aqueduct) - ETL, Data Warehousing, and Machine Learning Platform for LA City Data Science team. Handles extracting MDS provider APIs and storing in data warehouse. |
69 | 81 | * [`mds-agency-cli`](https://github.com/cityoflosangeles/mds-agency-cli) - Nodejs-based command-line interface to exercise the Agency API in the LADOT sandbox |
70 | | -* [`mds-core`](https://github.com/CityOfLosAngeles/mds-core) - An MDS Agency Server, built using PostgresQL, TypeScript, NodeJS. |
71 | 82 |
|
72 | 83 | ### City of Santa Monica |
73 | 84 | * [`mds-provider`](https://github.com/cityofsantamonica/mds-provider) - Python package implementing a provider API client, validation using JSONSchema, data loading to multiple targets, and fake provider data generation. |
|
0 commit comments