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

#570: Remove 'uses_forcing_file' and 'forcing_file'(_path) #826

Merged

Conversation

PhilMiller
Copy link
Contributor

@PhilMiller PhilMiller commented May 30, 2024

Fix #570 by removing support for unimplemented legacy parameters used to configure forcings inputs.

Removals

  • Bmi_Adapter: delete uses_forcing_file and forcing_file (path) members, construction arguments, and accessors
  • BMI Formulation classes: stop passing forcing_file arguments through to BMI Adapter classes

Changes

  • Delete all forcing_file keys in JSON built in test fixtures
  • Throw errors on affirmative use of the never-active and now-removed configuration options

Testing

  1. ctest
  2. CI

Notes

  • There may be documentation that should evolve in tandem
  • Users with legacy realization configs may start to see errors related to this. They've already almost certainly added the right options, since otherwise their runs just wouldn't work. So, fixing things is just a matter of removing the old bits from their files.

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 ➡️

@PhilMiller PhilMiller marked this pull request as ready for review May 30, 2024 23:29
@PhilMiller PhilMiller force-pushed the PhilMiller/570-remove-legacy-forcing branch from ed82282 to cb35f00 Compare June 7, 2024 15:01
@PhilMiller PhilMiller merged commit 84ae99c into NOAA-OWP:master Jun 11, 2024
19 checks passed
@PhilMiller PhilMiller deleted the PhilMiller/570-remove-legacy-forcing branch June 11, 2024 23:43
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.

Remove uses_forcing_file and forcing_file options
2 participants