NatLabRockies / NatLabRockies/H2Integrate
Allow user-made multivariable commodity stream definitions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Allow user-made multivariable commodity stream definitions
Currently, when using multivariable commodity streams, users must add them to commodity_stream_definitions.py which involves directly editing the H2I source code.
This is fine for the time being as this is a relatively new feature, but we should probably allow for a slick way for users to define their own multivariable streams.
Proposed solution
We could have the multivariable streams defined in the plant_config? There's not a spot that jumps out as great to me. Maybe it's a Python file (like we do for custom models) that's just a dict with the multivariable commodities? I might like that more so there's less yaml->python translation.
Alternatives considered
The obvious alternative is to not allowed custom multivariable commodity streams.
I don't think we strictly need to allow user-defined ones, especially because the entire capability can be defined outside of the multivariable stream handling (just use one-by-one streams instead).
Lastly, I don't think it's a huge burden for users to add their own multivariable stream definitions to the existing python file and submit a PR. We're an open-source tool, after all!
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with commodity_stream_definitions.py and the plant_config and custom-model configuration patterns mentioned in the issue. Compare the proposed configuration approaches and define a supported way for users to register multivariable streams without editing H2I source. Done means a user can supply a definition and use the multivariable stream successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100