Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GMNS 0.96, using Frictionless to automatically generate documentation #88

Merged
merged 173 commits into from
Aug 8, 2024

Conversation

ssmith55
Copy link
Collaborator

he GMNS specification is defined in a set of json files, one for each table. Release 0.96 uses Frictionless to automatically generate the following usable artifacts:

In the json files, the ID fields (node_id, link_id, etc.) has always been defined as type "any", allowing text or integer to be used. This follows the example of unique_ID as defined in GTFS. It is certainly possible that an application may further restrict ID fields to be integer (issue #83).

The automated generation of markdown has resulted in several non-substantive changes to the markdown files:

  • Their names are in lower case (e.g., node.md) rather than mixed case (e.g., Node.id)
  • Datatypes for the ID fields are "any", carried straight from the json files
  • Datatypes are number (rather than numeric), string (rather than text)

The PMC voting period is open until end of day Monday 8/5/2024.

ssmith55 and others added 30 commits May 20, 2024 11:28
Update develop to match minor changes to main
Added description to from_node_id, to_node_id.  More precise definition of capacity
Note that the format is implementation-agnostic
Move parent_link_id to match markdown and most examples
Corrected field
Added fields per .json spec
To store a network in a database, in gmns format, use this code to make the SQL create statements.  The sqlite database contains an example network
As of May 28
Fix timeset_definition foreign key
@ssmith55 ssmith55 merged commit 9745390 into main Aug 8, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants