Skip to content

Rename demand in converters#691

Merged
johnjasa merged 7 commits intoNatLabRockies:developfrom
johnjasa:rename_demand
Apr 27, 2026
Merged

Rename demand in converters#691
johnjasa merged 7 commits intoNatLabRockies:developfrom
johnjasa:rename_demand

Conversation

@johnjasa
Copy link
Copy Markdown
Collaborator

Rename converter _demand inputs to _set_point

Renames the {commodity}_demand input on all converter performance components to {commodity}_set_point, aligning converter naming with the storage baseclass convention.

Converters updated:

Component Old Input New Input
GridPerformanceModel electricity_demand electricity_set_point
NaturalGasPerformanceModel electricity_demand electricity_set_point
QuinnNuclearPerformanceModel electricity_demand electricity_set_point
SteamMethaneReformerPerformanceModel hydrogen_demand hydrogen_set_point
IronReductionPlantBasePerformanceComponent sponge_iron_demand sponge_iron_set_point
ElectricArcFurnacePlantBasePerformanceComponent steel_demand steel_set_point
MartinIronMinePerformanceComponent iron_ore_demand iron_ore_set_point

Section 1: Type of Contribution

  • Feature Enhancement
    • Framework
    • New Model
    • Updated Model
    • Tools/Utilities
    • Other (please describe):
  • Bug Fix
  • Documentation Update
  • CI Changes
  • Other (please describe):

Section 2: Draft PR Checklist

  • Open draft PR
  • Describe the feature that will be added
  • Fill out TODO list steps
  • Describe requested feedback from reviewers on draft PR
  • Complete Section 7: New Model Checklist (if applicable)

TODO:

  • Rename _demand inputs to _set_point in all converter performance components
  • Update tests, examples, YAML configs, and docs

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback: Is the _set_point naming convention the right choice, or should a different term be used?

Other feedback: N/A

Section 3: General PR Checklist

  • PR description thoroughly describes the new feature, bug fix, etc.
  • Added tests for new functionality or bug fixes
  • Tests pass (If not, and this is expected, please elaborate in the Section 6: Test Results)
  • Documentation
    • Docstrings are up-to-date
    • Related docs/ files are up-to-date, or added when necessary
    • Documentation has been rebuilt successfully
    • Examples have been updated (if applicable)
  • CHANGELOG.md
    • At least one complete sentence has been provided to describe the changes made in this PR
    • After the above, a hyperlink has been provided to the PR using the following format:
      "A complete thought. [PR XYZ]((https://github.com/NatLabRockies/H2Integrate/pull/XYZ)", where
      XYZ should be replaced with the actual number.

Section 4: Related Issues

N/A

Section 5: Impacted Areas of the Software

Section 5.1: New Files

N/A

Section 5.2: Modified Files

See Files Changed

Section 6: Additional Supporting Information

This is a breaking change for any user code that references the old _demand input names on converter components (e.g., prob.set_val("grid.electricity_demand", ...)). Users will need to update these references to _set_point.

Section 7: Test Results, if applicable

All converter unit and regression tests pass (77 tests across grid, nuclear, natural gas, iron mine, iron DRI, steel EAF, and SMR test suites).

@johnjasa johnjasa changed the base branch from main to develop April 22, 2026 02:36
Copy link
Copy Markdown
Collaborator

@elenya-grant elenya-grant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making these changes! I think this helps be more consistent with the storage performance models and controllers - thank you!

@johnjasa johnjasa changed the title Rename demand Rename demand in converters Apr 22, 2026
@johnjasa
Copy link
Copy Markdown
Collaborator Author

johnjasa commented Apr 24, 2026

Chatting with Elenya about this now, we could tentatively support a passthrough component that converts the demand into set_points, which opens the door for more complex control schemes. Elenya would want this to be in the controller_strategies section of the converter as a pass-through converter controller.

@johnjasa johnjasa merged commit 0ca4a20 into NatLabRockies:develop Apr 27, 2026
11 checks passed
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.

3 participants