Skip to content

Revises versioning for USEEIO models to use aliases#48

Merged
WesIngwersen merged 6 commits intomasterfrom
issue_47
Dec 4, 2024
Merged

Revises versioning for USEEIO models to use aliases#48
WesIngwersen merged 6 commits intomasterfrom
issue_47

Conversation

@WesIngwersen
Copy link
Copy Markdown

  • edit versioning scheme
  • add py script to select alias
  • add yamls for two lists of names

 - edit versioning scheme
 - add py script to select alias
 - add yamls for two lists of names
@WesIngwersen WesIngwersen requested a review from bl-young December 3, 2024 21:42
@WesIngwersen
Copy link
Copy Markdown
Author

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.

@WesIngwersen WesIngwersen marked this pull request as ready for review December 4, 2024 18:42
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see, nevermind it makes sense to keep it. I also see this section gets referenced in the table above

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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}
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@WesIngwersen
Copy link
Copy Markdown
Author

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.

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

@bl-young
Copy link
Copy Markdown
Contributor

bl-young commented Dec 4, 2024

ok i think looks good to me. script worked fine

@WesIngwersen WesIngwersen merged commit 2b441f0 into master Dec 4, 2024
@bl-young bl-young deleted the issue_47 branch December 4, 2024 20:10
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.

2 participants