Revises versioning for USEEIO models to use aliases#48
Conversation
WesIngwersen
commented
Dec 3, 2024
- edit versioning scheme
- add py script to select alias
- add yamls for two lists of names
|
I plan two more files at least ... a models.csv and then models.md which displays contents in md of the models.csv and aliases.csv files with some text. The models.csv will be a master list of all USEEIO models that we've created. |
| The aliases are chosen with a random script given a common set of names used for a generation and geo-resolution of models. | ||
| For example v1 state models aliases are drawn from names of American pies; v2 national models aliases are drawn from names of U.S. songbirds that migrate in the winter. | ||
|
|
||
| ## Base IO Schema |
There was a problem hiding this comment.
is this section necessary anymore since the schema would be identified in the alias?
Or perhaps this would be in the versioning table identifying a major data update for a minor version?
There was a problem hiding this comment.
Oh I see, nevermind it makes sense to keep it. I also see this section gets referenced in the table above
There was a problem hiding this comment.
I agree i'm not sure about leaving it later...we might consider moving that out once aliases are further fleshed out but i left it for now.
| The naming pattern is a set sequence of these parts with separator characters that are required when the given part is present. | ||
| ``` | ||
| {loc}{root} v{major}.{minor}.{patch}-{alias}-{YY} | ||
| ``` |
There was a problem hiding this comment.
the model spec files themselves typically do not have spaces in them. I am indifferent on whether that needs to be specified or can be intuited here.
There was a problem hiding this comment.
When writing the model name out we wanted to have the space like we did for USEEIO v2. I think its worth adding a note about
will save models.csv for a separate issue since this issue is really just intended to resolve the way models are named and not provide a list of all models |
|
ok i think looks good to me. script worked fine |