zephyr-data-specs / GMNS

General Modeling Network Specification
https://zephyr-data-specs.github.io/GMNS/
104 stars 15 forks source link

Restructure code, Data Package 2.0, Documentation Site, etc. #84

Closed dtemkin-volpe closed 1 month ago

dtemkin-volpe commented 1 month ago

Sorry for the big pull request! This request has a few changes, including:

Let me know if there are any issues with this or if anyone wants any changes.

ssmith55 commented 1 month ago

From what I can see, it looks good. As a test, I'd like to run the workflows. Something like: Test #1: change the ID from text to integer. See what happens to the markdown and generated sql. What field type for ID appears in the markdown (ID to match the json, or would it be integer or test?)
Test #2: change something else. Make sure we have not broken what we have done before Finally, in our Cambridge Intersection example, double check that the field_type in the config file is consistent with the ID field types in the actual data.

dtemkin-volpe commented 1 month ago

I think the idea was that people could define what types the id fields would be in their config.csv file, rather than in the json spec files (so the markdown documentation or generated SQL wouldn't change). Because the config.csv file isn't really required, the id fields are defined as an any type in the spec, and downstream software could then enforce whatever is set in the config file. I enabled the workflow on my end, let me try changing something and make sure everything works still.

ssmith55 commented 1 month ago

Yes, that makes sense. Thank you. Maybe we can create two versions of the template SQLite database, one with INT keys and the other with TEXT keys.

ssmith55 commented 1 month ago

I did a little test, and all seems to be well. Diego, I'm ok with merging if you feel it is ready. Thanks.