Update Naming Convention in Open-Loop Converter Control Strategies#631
Draft
elenya-grant wants to merge 3 commits intoNatLabRockies:developfrom
Draft
Update Naming Convention in Open-Loop Converter Control Strategies#631elenya-grant wants to merge 3 commits intoNatLabRockies:developfrom
elenya-grant wants to merge 3 commits intoNatLabRockies:developfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update Naming Convention in Open-Loop Converter Control Strategies
Update output naming convention in open-loop converter control strategies to align with the naming convention of the storage performance models.
f"{commodity}_unmet_demand"->f"unmet_{commodity}_demand_out"f"{commodity}_unused_commodity"->f"unused_{commodity}_out"Removed output
f"total_{commodity}_unmet_demand"Questions for reviewers are outlined in Section 2. This is ready for a draft review.
Section 1: Type of Contribution
Section 2: Draft PR Checklist
TODO:
Type of Reviewer Feedback Requested (on Draft PR)
Structural feedback:
PerformanceModelBaseclassto these models? These models are more like ways to represent a generic end-use (or reference signal) rather than actual control strategies. So-if they represent an end-use and we may want to calculate the LCO of the end-use demand, then we'd need these to calculate/output rated commodity capacity and capacity factor.commodity_set_pointmean with respect to converter controllers? Right now, it's the total commodity out to meet demand (equivalent tocommodity_outfrom storage performance models)Implementation feedback:
Other feedback:
Section 3: General PR Checklist
docs/files are up-to-date, or added when necessaryCHANGELOG.md"A complete thought. [PR XYZ]((https://github.com/NatLabRockies/H2Integrate/pull/XYZ)", where
XYZshould be replaced with the actual number.Section 3: Related Issues
Section 4: Impacted Areas of the Software
Section 4.1: New Files
N/A
Section 4.2: Modified Files
h2integrate/control/control_strategies/converters/demand_openloop_converter_controller.pyDemandOpenLoopConverterController: renamed outputsh2integrate/control/control_strategies/converters/flexible_demand_openloop_controller.pyFlexibleDemandOpenLoopConverterController: renamed outputsh2integrate/control/control_strategies/converters/openloop_controller_base.pyConverterOpenLoopControlBase: removedtotal_commodity_unmet_demandfrom output, updated output naming as outlined in Section 1.Section 5: Additional Supporting Information
Section 6: Test Results, if applicable
Section 7 (Optional): New Model Checklist
docs/developer_guide/coding_guidelines.mdattrsclass to define theConfigto load in attributes for the modelBaseConfigorCostModelBaseConfiginitialize()method,setup()method,compute()methodCostModelBaseClasssupported_models.pycreate_financial_modelinh2integrate_model.pytest_all_examples.pydocs/user_guide/model_overview.mddocs/section<model_name>.mdis added to the_toc.yml