Refactor: bmi_model.py, config.py, model.py

[mdeshotel]

PR to merge a pre_dev branch containing major refactoring to BMI_model.py, Config.py, and Model.py. The pre_dev branch is intended as a staging branch whereby combinations of the 3 refactored files can be tested and adjustments made before an actual merge into development.

Additions

Removals

Changes

Testing

Screenshots

Notes

Todos

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
• Visually tested in supported browsers and devices (see checklist below 👇)
• Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
• Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

• Linux

[mxkpp]

This PR received merges equivalent to these now-closed PRs / branches (those merges need to be reviewed, but I have closed the other PRs to help clean up the repo):

Already merged into this PR

Refactor of config.py:

PR: #163
aka Branch: mdeshotel_ngwpc-10580

Refactor of bmi_model.py

Branch: mdeshotel_ngwpc-10578

Refactor of model.py

PR: #149
aka Branch: maxkipp-refactor-model-py

[mxkpp]

Rebased against development.

[mxkpp]

Rebased against NGWPC-7625_PI_10_ngen_forcing_refactor and changed the base to that.

[idtodd]

Suggested change

	element_slope_azmuith[i] = hyfab.aspect_circmean[
	i
	] # NHF aspect is currently in radians, may need to be converted to degrees
	# NHF aspect is currently in radians, may need to be converted to degrees
	element_slope_azmuith[i] = hyfab.aspect_circmean[i]

[mxkpp]

Updated

[idtodd]

Double import

Suggested change

	if TYPE_CHECKING:
	from NextGen_Forcings_Engine_BMI.NextGen_Forcings_Engine.core.config import (
	ConfigOptions,
	)

[mxkpp]

Updated

[idtodd]

Are these necessary? BMI standards have the constructor not take any additional arguments. If there are properties that the BMI should potentially know about, they should probably be included in the config file and loaded from that in initialize.

[mxkpp]

The official initialize() method (BMI spec) does take only a config file. The class's __init__ exposes these overrides for these 3 parameters. run_bmi_model.py leverages these overrides and continues their exposure through to CLI args, presumably so that a user could point to one configuration file, while varying one or more of these parameters in a for loop, or some similar workflow. Since the run_bmi_model.py was originally set up this way, I feel that we should preserve this behavior.

[mxkpp]

Rebased after rebasing the base