Skip to content

Correct pipe rate units from galUS to galUS/h - #813

Merged
johnjasa merged 3 commits into
NatLabRockies:developfrom
jaredthomas68:galUS
Jul 25, 2026
Merged

Correct pipe rate units from galUS to galUS/h#813
johnjasa merged 3 commits into
NatLabRockies:developfrom
jaredthomas68:galUS

Conversation

@jaredthomas68

@jaredthomas68 jaredthomas68 commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

Correct pipe rate units from galUS to galUS/h

The pipe transporter specified units of galUS for the rate units of water, which was then propagated into the iron work. This PR corrects rate units from galUS to galUS/h where appropriate.

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:

  • Step 1
  • Step 2

Type of Reviewer Feedback Requested (on Draft PR)

Structural feedback:

Implementation feedback:

Other feedback:

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

Somewhat related to #223

Section 5: Impacted Areas of the Software

Section 5.1: New Files

  • None

Section 5.2: Modified Files

  • examples/21_iron_examples/iron_dri/tech_config.yaml
    commodity_rate_units (technologies entries): Updated water commodity rate units from galUS to galUS/h to represent a flow rate consistently with hourly usage assumptions.

  • examples/21_iron_examples/iron_mapping/tech_config.yaml
    commodity_rate_units (technologies entry): Updated water commodity rate units from galUS to galUS/h for consistency with rate-based feedstock accounting.

  • h2integrate/converters/iron/iron_dri_plant.py
    HydrogenIronReductionPlantPerformanceComponent (line 69): Changed water units mapping to galUS/h so internal unit metadata matches hourly commodity rates.
    NaturalGasIronReductionPlantPerformanceComponent (line 96): Changed water units mapping to galUS/h for parity with the hydrogen pathway and downstream unit checks.

  • h2integrate/converters/iron/test/test_rosner_dri.py
    ng_feedstock_availability_costs (line 50): Updated expected water units from galUS to galUS/h to match converter unit definitions.
    h2_feedstock_availability_costs (line 83): Updated expected water units from galUS to galUS/h to keep hydrogen-case assertions aligned.

  • h2integrate/converters/steel/steel_eaf_plant.py
    HydrogenEAFPlantPerformanceComponent (line 66): Changed water units mapping to galUS/h to use hourly flow units.
    NaturalGasEAFPlantPerformanceComponent (line 93): Changed water units mapping to galUS/h for consistent EAF feedstock-rate treatment.

  • h2integrate/converters/steel/test/test_rosner_eaf.py
    ng_feedstock_availability_costs (line 65): Updated expected water units to galUS/h so test expectations match EAF model output metadata.
    h2_feedstock_availability_costs (line 103): Updated expected water units to galUS/h for hydrogen EAF case consistency.

  • h2integrate/feedstocks/test/test_feedstocks.py
    test_multiple_different_type_feedstocks (line 328): Corrected electricity units expectation from MW*h to MW to align with rate-based input conventions.
    test_multiple_different_type_feedstocks (line 334): Updated water units expectation from galUS to galUS/h to align with hourly water consumption rates.

  • h2integrate/transporters/pipe.py
    PipePerformanceModel unit selection (line 41): Changed water commodity units from galUS to galUS/h.

Section 6: Additional Supporting Information

Section 7: Test Results, if applicable

Section 8 (Optional): New Model Checklist

  • Model Structure:
    • Follows established naming conventions outlined in docs/developer_guide/coding_guidelines.md
    • Used attrs class to define the Config to load in attributes for the model
      • If applicable: inherit from BaseConfig or CostModelBaseConfig
    • Added: initialize() method, setup() method, compute() method
      • If applicable: inherit from CostModelBaseClass
  • Integration: Model has been properly integrated into H2Integrate
    • Added to supported_models.py
    • If a new commodity_type is added, update create_financial_model in h2integrate_model.py
  • Tests: Unit tests have been added for the new model
    • Pytest-style unit tests
    • Unit tests are in a "test" folder within the folder a new model was added to
    • If applicable add integration tests
  • Example: If applicable, a working example demonstrating the new model has been created
    • Input file comments
    • Run file comments
    • Example has been tested and runs successfully in test_all_examples.py
  • Documentation:
    • Write docstrings using the Google style
    • Model added to the main models list in docs/user_guide/model_overview.md
      • Model documentation page added to the appropriate docs/ section
      • <model_name>.md is added to the _toc.yml
    • Run generate_class_hierarchy.py to update the class hierarchy diagram in docs/developer_guide/class_structure.md

@johnjasa johnjasa left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks @jaredthomas68!

@johnjasa
johnjasa merged commit c8f3293 into NatLabRockies:develop Jul 25, 2026
22 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.

2 participants