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

Add LinkItem type; Update model_params field to support new LinkItem type #75

Merged
merged 3 commits into from
Nov 14, 2023

Conversation

aaraney
Copy link
Member

@aaraney aaraney commented Nov 14, 2023

fixes #72

ngen.config - [0.2.0]

Additions

  • Add LinkItem type to capture the concept of a source and a variable from that source.

Changes

  • BREAKING: BMIParams's model_params field no longer supports Mapping[str, str]. This was never supported by NextGen. See ngen-config Update model_param spec #72 for more information. Supported value types are now int, float, sequence[int], sequence[float], LinkItem.
  • BMIParams's (and subtypes) model_params field now supports LinkItem as a mapping value type.

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Add LinkItem type to capture the concept of a source and a variable from
that source.

Update model_params field to support new LinkItem type as value type.

Fix model_params field associated types. Previously str value types were
supported, but have never been supported by NextGen (see NOAA-OWP#72 for
specifics). Supported value types are now int, float, seq[int],
seq[float], LinkItem.
@aaraney
Copy link
Member Author

aaraney commented Nov 14, 2023

@hellkite500, changing the types accepted by the model_params is a breaking change as I removed Mapping[str, str]. That should merit a major version bump, however since we are still <1.0.0 im fine with only bumping the minor version. What are your thoughts?

@aaraney aaraney added bug Something isn't working enhancement New feature or request ngen.config Related to ngen.config package labels Nov 14, 2023
@aaraney
Copy link
Member Author

aaraney commented Nov 14, 2023

@hellkite500, I assumed you would agree with me about the minor version bump, so for getting this merged more quickly, I went ahead and pushed that change. JLMK if you want me to roll it back and do something different. If not, feel free to review and merge. We should be good to go.

@hellkite500 hellkite500 merged commit 1f79b95 into NOAA-OWP:master Nov 14, 2023
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request ngen.config Related to ngen.config package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ngen-config Update model_param spec
2 participants