Python tool for General Modeling Network Specification (GMNS) developed by Zephyr Foundation for Travel Analysis.
git clone https://github.com/e-lo/GMNSpy.git
cd GMNSpy
pip install .Returns a dataframe that conforms to the specified schema and have been validated.
df = gmnspy.in_out.read_gmns_csv(data_filename, schema_file=schemafilename)Returns a dictionary of dataframes that conform to the specified schema and have been validated.
Checks foreign keys between files.
net = gmnspy.in_out.read_gmns_network(data_directory, config: "gmns.spec.json")A copy of the GMNS specification is kept in the /spec sub-directory as a
series of JSON tables.
Data table schemas are specified in JSON and are compatible with the frictionless data table schema standards.
Example:
{
"primaryKey": "segment_id",
"missingValues": ["NaN",""],
"fields": [
{
"name": "segment_id",
"type": "any",
"description": "Primary key.",
"constraints": {
"required": true,
"unique": true
}
},
{
"name": "road_link_id",
"type": "any",
"description": "Required. Foreign key to road_links. The link that the segment is located on.",
"foreign_key": "link.link_id",
"constraints": {
"required": true
}
},
{
"name": "ref_node_id",
"type": "any",
"description": "Required. Foreign key to node.",
"foreign_key": "node.node_id",
"constraints": {
"required": true
}
},
{
"name": "start_lr",
"type": "number",
"description": "Required. Distance from ref_node_id.",
"constraints": {
"required": true,
"minimum": 0
}
},
{
"name": "end_lr",
"type": "number",
"description": "Required. Distance from ref_node_id.",
"constraints": {
"required": true,
"minimum": 0
}
}
]
}
Network data schemas are specified in JSON and are compatible with the frictionless data data package standards.
Example:
{
"profile": "gmns-data-package",
"profile_version":0.0,
"name": "my-dataset",
"resources": [
{
"name":"link",
"path": "link.csv",
"schema": "link.schema.json",
"required": true
},
{
"name":"node",
"path": "node.csv",
"schema": "node.schema.json",
"required": true
}
]
}Please add issues, bugs, and feature requests to Github.
Current feature roadmap includes:
- conversion tools from open street map
- network connectivity checks
- auto documentation of schema to markdown files
- tests tests tests
Feel free to submit pull requests for consideration. See CONTRIBUTING for more detailed instructions.
Primary Author: Elizabeth Sall, UrbanLabs LLC
Contributing authors and code maintainers:
- Pedro Carmago, OuterLoop Consulting
- Ian Berg, Volpe Center
See all in CONTRIBUTORS.md
The code herein is licensed under the Apache License 2.0 as defined in file.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent