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

Update variable names/units in BMI modules #626

Open
shorvath-noaa opened this issue Aug 2, 2023 · 3 comments
Open

Update variable names/units in BMI modules #626

shorvath-noaa opened this issue Aug 2, 2023 · 3 comments
Assignees

Comments

@shorvath-noaa
Copy link
Contributor

We've used internal t-route variables names in our BMI modules, but we should update these to conform to CSDMS standard names.

Current behavior

In bmi_troute.py and bmi_reservoirs.py, variable names are mostly internal t-route names.

We also need to update the dictionary linking the (should be) standard CSDMS names and internal t-route names, along with respective units.

Once both of those are complete, we can change the initialization of variables to be a simple for loop.

Expected behavior

Standard names are generally of the form object__quantity.
For example: channel_bank_water__volume-per-length_flow_rate ("lateral flow" into side of channel)

More examples.

Steps to replicate behavior (include URLs)

Screenshots

@shorvath-noaa
Copy link
Contributor Author

I believe @kumdonoaa has begun work on this issue.

@kumdonoaa
Copy link
Contributor

I believe @kumdonoaa has begun work on this issue.
Yes. I am working on this.

@kumdonoaa
Copy link
Contributor

@AminTorabi-NOAA This is what I am working on updating current variable names according to CSDMS standard names.

In the codes attached here, commented-out names are existing or internal names t-route use and names on the left on each code line are my suggested name. We can modify them as necessary as well.

https://github.com/kumdonoaa/t-route/blob/a4731b94745c0e3425659da15dea315d0caffd1c/src/bmi_DAforcing.py#L80-L86

https://github.com/kumdonoaa/t-route/blob/a4731b94745c0e3425659da15dea315d0caffd1c/src/bmi_DAforcing.py#L110-L118

I think @AminTorabi-NOAA can start with variables used in these files:
https://github.com/NOAA-OWP/t-route/blob/master/src/bmi_troute.py
https://github.com/NOAA-OWP/t-route/blob/master/src/bmi_reservoirs.py

Changing names should involve updating the same or similar names used in related files, so let's suggest new names here in this Issue first until we all agree on.

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

No branches or pull requests

4 participants