Merge pull request #691 from johnjasa/rename_demand

johnjasa · web-flow · commit 0ca4a202cdad · 2026-04-27T17:57:11.000-05:00
Rename demand in converters
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 - Change commodity in DRI and EAF model from pig iron to sponge iron based on likely carbon content [PR 670](https://github.com/NatLabRockies/H2Integrate/pull/670)
 - Bugfix for round-trip efficiency handling when calling `check_inputs` around `StoragePerformanceModel` [PR 684](https://github.com/NatLabRockies/H2Integrate/pull/684)
 - Bugfix. Include nuclear in electricity producing tech list and improve error message for zero-length electricity producing techs in model when electricity is specified as the commodity. [PR 685](https://github.com/NatLabRockies/H2Integrate/pull/685)
+- Renamed `{commodity}_demand` inputs to `{commodity}_set_point` on all converter performance components to align with storage baseclass naming and distinguish converter operating targets from demand components. [PR 691](https://github.com/NatLabRockies/H2Integrate/pull/691)
 - Add electric arc furnace performance and cost models based on the Carnegie Mellon University DecarbSTEEL v5 excel model [PR 686](https://github.com/NatLabRockies/H2Integrate/pull/686)
   - Adds scrap-only performance model
   - Adds DRI + scrap performance model
diff --git a/docs/technology_models/grid.md b/docs/technology_models/grid.md
@@ -24,7 +24,7 @@ Multiple grid instances may be used within the same plant to represent different
 | ------------------------ | ------------------ | ----- | ----------------------------------------------------------------- |
 | `interconnection_size`   | scalar             | kW    | Maximum power capacity for grid connection.                       |
 | `electricity_in`         | array[n_timesteps] | kW    | Electricity flowing into the grid (selling to grid).              |
-| `electricity_demand`     | array[n_timesteps] | kW    | Electricity demand from downstream technologies.                  |
+| `electricity_set_point`     | array[n_timesteps] | kW    | Electricity set point from downstream technologies.                  |
 
 **Outputs**
 | Name                       | Shape              | Units | Description                                                         |
diff --git a/docs/technology_models/natural_gas.md b/docs/technology_models/natural_gas.md
@@ -14,8 +14,8 @@ The performance model requires the following parameters:
   - **NGCT (Combustion Turbine)**: 10-14 MMBtu/MWh (lower efficiency, faster response)
 
 Optional parameter:
-- `electricity_demand` (optional): Defaults to the `system_capacity` but can be set to a particular demand profile.
-  - See example `16_natural_gas` to see how missed load from the battery is set as the electricity demand for the natural gas plant.
+- `electricity_set_point` (optional): Defaults to the `system_capacity` but can be set to a particular set point profile.
+  - See example `16_natural_gas` to see how missed load from the battery is set as the electricity set point for the natural gas plant.
 
 The model implements the relationship:
 
diff --git a/docs/technology_models/nuclear.md b/docs/technology_models/nuclear.md
@@ -14,7 +14,7 @@ The performance model limits electricity production by the rated capacity and an
 | Name | Shape | Units | Description |
 | --- | --- | --- | --- |
 | `system_capacity` | scalar | kW | Rated electrical capacity. |
-| `electricity_demand` | array[n_timesteps] | kW | Optional demand profile; defaults to rated capacity. |
+| `electricity_set_point` | array[n_timesteps] | kW | Optional set point profile; defaults to rated capacity. |
 
 **Outputs**
 | Name | Shape | Units | Description |
diff --git a/examples/16_natural_gas/plant_config.yaml b/examples/16_natural_gas/plant_config.yaml
@@ -26,7 +26,7 @@ technology_interconnections:
   # subtract the combined generation from the demand profile
   - [elec_combiner, electrical_load_demand, electricity, cable]
   # connect the remaining electricity demand to the NG plant
-  - [electrical_load_demand, natural_gas_plant, [unmet_electricity_demand_out, electricity_demand]]
+  - [electrical_load_demand, natural_gas_plant, [unmet_electricity_demand_out, electricity_set_point]]
   # connect NG feedstock to NG plant
   - [ng_feedstock, natural_gas_plant, natural_gas, pipe]
   # connect natural gas and solar to finance combiner
diff --git a/examples/23_solar_wind_ng_demand/plant_config.yaml b/examples/23_solar_wind_ng_demand/plant_config.yaml
@@ -27,7 +27,7 @@ technology_interconnections:
                                                                 # connect NG feedstock to NG plant
   - [combiner, electrical_load_demand, [electricity_out, electricity_in]]
                                                                                  # subtract wind and solar from demand
-  - [electrical_load_demand, natural_gas_plant, [unmet_electricity_demand_out, electricity_demand]]
+  - [electrical_load_demand, natural_gas_plant, [unmet_electricity_demand_out, electricity_set_point]]
                                                                                                        # give remaining load demand to natural gas plant
   - [combiner, fin_combiner, electricity, cable]
   - [natural_gas_plant, fin_combiner, electricity, cable]
diff --git a/examples/24_solar_battery_grid/plant_config.yaml b/examples/24_solar_battery_grid/plant_config.yaml
@@ -27,7 +27,7 @@ technology_interconnections:
   # subtract variable generation from the demand
   - [bat_combiner, electrical_load_demand, electricity, cable]
   # connect remaining demand to grid buying
-  - [electrical_load_demand, grid_buy, [unmet_electricity_demand_out, electricity_demand]]
+  - [electrical_load_demand, grid_buy, [unmet_electricity_demand_out, electricity_set_point]]
   # connect surplus generation to grid selling
   - [electrical_load_demand, grid_sell, [unused_electricity_out, electricity_in]]
   # combine electricity generated from solar and electricity bought from grid
diff --git a/examples/33_peak_load_management/plant_config.yaml b/examples/33_peak_load_management/plant_config.yaml
@@ -11,4 +11,4 @@ technology_interconnections:
   # include battery charge/discharge in the load
   - [battery, electrical_load_demand, [electricity_out, electricity_in]]
   # buy power from the grid to fulfill demand including to accommodate battery operation
-  - [electrical_load_demand, grid_buy, [unmet_electricity_demand_out, electricity_demand]]
+  - [electrical_load_demand, grid_buy, [unmet_electricity_demand_out, electricity_set_point]]
diff --git a/examples/test/test_all_examples.py b/examples/test/test_all_examples.py
@@ -1057,7 +1057,9 @@ def test_natural_gas_example(subtests, temp_copy_of_example):
     pre_ng_missed_load = model.prob.get_val(
         "electrical_load_demand.unmet_electricity_demand_out", units="kW"
     )
-    ng_electricity_demand = model.prob.get_val("natural_gas_plant.electricity_demand", units="kW")
+    ng_electricity_set_point = model.prob.get_val(
+        "natural_gas_plant.electricity_set_point", units="kW"
+    )
     ng_electricity_production = model.prob.get_val("natural_gas_plant.electricity_out", units="kW")
     bat_init_charge = 200000.0 * 0.1  # max capacity in kW and initial charge rate percentage
 
@@ -1091,11 +1093,11 @@ def test_natural_gas_example(subtests, temp_copy_of_example):
             == sum(ng_electricity_production) + solar_aep
         )
 
-    with subtests.test("Check missed load is natural gas plant electricity demand"):
-        assert pytest.approx(ng_electricity_demand, rel=1e-6) == pre_ng_missed_load
+    with subtests.test("Check missed load is natural gas plant electricity set point"):
+        assert pytest.approx(ng_electricity_set_point, rel=1e-6) == pre_ng_missed_load
 
-    with subtests.test("Check natural_gas_plant electricity out equals demand"):
-        assert pytest.approx(ng_electricity_demand, rel=1e-6) == ng_electricity_production
+    with subtests.test("Check natural_gas_plant electricity out equals set point"):
+        assert pytest.approx(ng_electricity_set_point, rel=1e-6) == ng_electricity_production
 
     # Subtests for checking specific values
     with subtests.test("Check Natural Gas CapEx"):
diff --git a/h2integrate/converters/grid/grid.py b/h2integrate/converters/grid/grid.py
@@ -41,7 +41,7 @@ class GridPerformanceModel(PerformanceModelBaseClass):
     Inputs
         interconnection_size (float): Maximum power capacity for grid connection (kW).
         electricity_in (array): Power flowing into the grid (selling) (kW).
-        electricity_demand (array): Downstream electricity demand (kW).
+        electricity_set_point (array): Downstream electricity set point (kW).
 
     Outputs
         electricity_out (array): Power flowing out of the grid (buying) (kW).
@@ -84,13 +84,13 @@ def setup(self):
             desc="Electricity flowing into grid interconnection point (selling to grid)",
         )
 
-        # Electricity demand from downstream (for buying from grid)
+        # Electricity set point from downstream (for buying from grid)
         self.add_input(
-            "electricity_demand",
+            "electricity_set_point",
             val=0.0,
             shape=n_timesteps,
             units=self.commodity_rate_units,
-            desc="Electricity demand from downstream technologies",
+            desc="Electricity set point from downstream technologies",
         )
 
         # electricity_out is electricity flowing OUT OF the grid (buying from grid)
@@ -126,12 +126,12 @@ def compute(self, inputs, outputs):
         electricity_sold = np.clip(inputs["electricity_in"], 0, interconnection_size)
         outputs["electricity_sold"] = electricity_sold
 
-        # Buying: electricity flows out of grid to meet demand, limited by interconnection
-        electricity_bought = np.clip(inputs["electricity_demand"], 0, interconnection_size)
+        # Buying: electricity flows out of grid to meet set point, limited by interconnection
+        electricity_bought = np.clip(inputs["electricity_set_point"], 0, interconnection_size)
         outputs["electricity_out"] = electricity_bought
 
-        # Unmet demand if demand exceeds interconnection size
-        outputs["electricity_unmet_demand"] = inputs["electricity_demand"] - electricity_bought
+        # Unmet demand if set point exceeds interconnection size
+        outputs["electricity_unmet_demand"] = inputs["electricity_set_point"] - electricity_bought
 
         # Not sold electricity if demand exceeds interconnection size
         outputs["electricity_excess"] = inputs["electricity_in"] - electricity_sold
diff --git a/h2integrate/converters/grid/test/test_grid.py b/h2integrate/converters/grid/test/test_grid.py
@@ -45,7 +45,7 @@ def test_grid_performance_outputs(plant_config, subtests):
 
     # Set demand below interconnection limit
     demand = np.full(n_timesteps, 30000.0)  # 30 MW demand
-    prob.set_val("comp.electricity_demand", demand)
+    prob.set_val("comp.electricity_set_point", demand)
 
     prob.run_model()
 
@@ -148,7 +148,7 @@ def test_buying_electricity(plant_config, n_timesteps):
 
     # Set demand below interconnection limit
     demand = np.full(n_timesteps, 30000.0)  # 30 MW demand
-    prob.set_val("grid.electricity_demand", demand)
+    prob.set_val("grid.electricity_set_point", demand)
 
     prob.run_model()
 
@@ -177,7 +177,7 @@ def test_buying_with_interconnection_limit(plant_config, n_timesteps):
 
     # Set demand above interconnection limit
     demand = np.full(n_timesteps, 60000.0)  # 60 MW demand
-    prob.set_val("grid.electricity_demand", demand)
+    prob.set_val("grid.electricity_set_point", demand)
 
     prob.run_model()
 
@@ -247,7 +247,7 @@ def test_simultaneous_buy_and_sell(plant_config, n_timesteps):
     electricity_demand = np.full(n_timesteps, 40000.0)  # 40 MW out
 
     prob.set_val("grid.electricity_in", electricity_in)
-    prob.set_val("grid.electricity_demand", electricity_demand)
+    prob.set_val("grid.electricity_set_point", electricity_demand)
 
     prob.run_model()
 
@@ -272,7 +272,7 @@ def test_varying_demand_profile(plant_config, n_timesteps):
 
     # Create varying demand profile
     demand = np.array([10000, 20000, 30000, 50000, 70000, 90000, 110000, 80000, 60000, 40000])
-    prob.set_val("grid.electricity_demand", demand)
+    prob.set_val("grid.electricity_set_point", demand)
 
     prob.run_model()
 
@@ -302,7 +302,7 @@ def test_non_hourly_dt_demand_profile(subtests, plant_config, n_timesteps):
 
     # Create varying demand profile
     demand = np.array([10000, 20000, 30000, 50000, 70000, 90000, 110000, 80000, 60000, 40000])
-    prob.set_val("grid.electricity_demand", demand, units="kW")
+    prob.set_val("grid.electricity_set_point", demand, units="kW")
 
     prob.run_model()
 
@@ -390,7 +390,7 @@ def test_grid_integration_dt_1800(subtests, tmp_path):
     h2i.setup()
 
     demand = np.full(n_timesteps, demand_kw)
-    h2i.prob.set_val("grid.electricity_demand", demand, units="kW")
+    h2i.prob.set_val("grid.electricity_set_point", demand, units="kW")
     h2i.prob.run_model()
 
     expected_out = np.full(n_timesteps, demand_kw)
diff --git a/h2integrate/converters/hydrogen/steam_methane_reformer.py b/h2integrate/converters/hydrogen/steam_methane_reformer.py
@@ -88,13 +88,13 @@ def setup(self):
             desc="SMR plant rated capacity in t/d",
         )
 
-        # Default the hydrogen demand input as the rated capacity
+        # Default the hydrogen set point input as the rated capacity
         self.add_input(
-            f"{self.commodity}_demand",
+            f"{self.commodity}_set_point",
             val=self.config.system_capacity_tonnes_per_day * (1000 / 24),  # convert t/d to kg/h
             shape=n_timesteps,
             units=self.commodity_rate_units,
-            desc="Hydrogen demand for SMR plant",
+            desc="Hydrogen set point for SMR plant",
         )
 
         # Add natural gas input, default to 0 --> set using feedstock component
@@ -168,7 +168,7 @@ def compute(self, inputs, outputs):
         Args:
             inputs: OpenMDAO inputs object containing natural_gas_in,
                 natural_gas_usage_rate, electricity_usage_rate,
-                system_capacity, and hydrogen_demand.
+                system_capacity, and hydrogen_set_point.
             outputs: OpenMDAO outputs object for hydrogen_out, natural_gas_consumed,
                 electricity_consumed, and unmet_hydrogen_demand.
         """
@@ -182,14 +182,14 @@ def compute(self, inputs, outputs):
         electricity_usage_kWh_per_kg = inputs["electricity_usage_rate"]
         max_electricity_consumption = system_capacity_kg_per_hour * electricity_usage_kWh_per_kg
 
-        # hydrogen demand, saturated at maximum rated system capacity
-        hydrogen_demand = np.where(
-            inputs["hydrogen_demand"] > system_capacity_kg_per_hour,
+        # hydrogen set point, saturated at maximum rated system capacity
+        hydrogen_set_point = np.where(
+            inputs["hydrogen_set_point"] > system_capacity_kg_per_hour,
             system_capacity_kg_per_hour,
-            inputs["hydrogen_demand"],
+            inputs["hydrogen_set_point"],
         )
-        natural_gas_demand = hydrogen_demand * natural_gas_usage_mmbtu_per_kg
-        electricity_demand = hydrogen_demand * electricity_usage_kWh_per_kg
+        natural_gas_demand = hydrogen_set_point * natural_gas_usage_mmbtu_per_kg
+        electricity_demand = hydrogen_set_point * electricity_usage_kWh_per_kg
 
         # available feedstock, saturated at maximum system feedstock consumption
         natural_gas_available = np.where(
@@ -241,7 +241,7 @@ def compute(self, inputs, outputs):
         outputs["annual_hydrogen_produced"] = outputs["total_hydrogen_produced"] * (
             1 / self.fraction_of_year_simulated
         )
-        outputs["unmet_hydrogen_demand"] = inputs["hydrogen_demand"] - hydrogen_out
+        outputs["unmet_hydrogen_demand"] = inputs["hydrogen_set_point"] - hydrogen_out
         outputs["total_energy_conversion_ratio"] = total_energy_conversion_ratio
 
 
diff --git a/h2integrate/converters/iron/iron_dri_base.py b/h2integrate/converters/iron/iron_dri_base.py
@@ -75,13 +75,13 @@ def setup(self):
                 desc=f"{feedstock} consumed for iron reduction",
             )
 
-        # Default the sponge iron demand input as the rated capacity
+        # Default the sponge iron set point input as the rated capacity
         self.add_input(
-            "sponge_iron_demand",
+            "sponge_iron_set_point",
             val=self.config.sponge_iron_production_rate_tonnes_per_hr,
             shape=n_timesteps,
             units="t/h",
-            desc="Pig iron demand for iron plant",
+            desc="Pig iron set point for iron plant",
         )
 
         coeff_fpath = ROOT_DIR / "converters" / "iron" / "rosner" / "perf_coeffs.csv"
@@ -224,20 +224,20 @@ def compute(self, inputs, outputs):
                 feedstocks["Name"] == "Reformer Catalyst"
             ]["Value"].sum()
 
-        # sponge iron demand, saturated at maximum rated system capacity
-        sponge_iron_demand = np.where(
-            inputs["sponge_iron_demand"] > inputs["system_capacity"],
+        # sponge iron set point, saturated at maximum rated system capacity
+        sponge_iron_set_point = np.where(
+            inputs["sponge_iron_set_point"] > inputs["system_capacity"],
             inputs["system_capacity"],
-            inputs["sponge_iron_demand"],
+            inputs["sponge_iron_set_point"],
         )
 
         # initialize an array of how much sponge iron could be produced
-        # from the available feedstocks and the demand
+        # from the available feedstocks and the set point
         sponge_iron_from_feedstocks = np.zeros(
-            (len(feedstocks_usage_rates) + 1, len(inputs["sponge_iron_demand"]))
+            (len(feedstocks_usage_rates) + 1, len(inputs["sponge_iron_set_point"]))
         )
-        # first entry is the sponge iron demand
-        sponge_iron_from_feedstocks[0] = sponge_iron_demand
+        # first entry is the sponge iron set point
+        sponge_iron_from_feedstocks[0] = sponge_iron_set_point
         ii = 1
         for feedstock_type, consumption_rate in feedstocks_usage_rates.items():
             # calculate max inputs/outputs based on rated capacity
diff --git a/h2integrate/converters/iron/martin_mine_perf_model.py b/h2integrate/converters/iron/martin_mine_perf_model.py
@@ -76,13 +76,13 @@ def setup(self):
             desc="Crude ore input",
         )
 
-        # Default the ore demand input as the rated capacity
+        # Default the ore set point input as the rated capacity
         self.add_input(
-            "iron_ore_demand",
+            "iron_ore_set_point",
             val=self.config.max_ore_production_rate_tonnes_per_hr,
             shape=n_timesteps,
             units="t/h",
-            desc="Iron ore demand for iron mine",
+            desc="Iron ore set point for iron mine",
         )
 
         self.add_output(
@@ -202,11 +202,11 @@ def compute(self, inputs, outputs):
         max_crude_ore_consumption = inputs["system_capacity"] * crude_ore_usage_per_processed_ore
         max_energy_consumption = inputs["system_capacity"] * energy_usage_per_processed_ore
 
-        # iron ore demand, saturated at maximum rated system capacity
-        processed_ore_demand = np.where(
-            inputs["iron_ore_demand"] > inputs["system_capacity"],
+        # iron ore set point, saturated at maximum rated system capacity
+        processed_ore_set_point = np.where(
+            inputs["iron_ore_set_point"] > inputs["system_capacity"],
             inputs["system_capacity"],
-            inputs["iron_ore_demand"],
+            inputs["iron_ore_set_point"],
         )
 
         # available feedstocks, saturated at maximum system feedstock consumption
@@ -226,9 +226,9 @@ def compute(self, inputs, outputs):
         processed_ore_from_electricity = energy_available / energy_usage_per_processed_ore
         processed_ore_from_crude_ore = crude_ore_available / crude_ore_usage_per_processed_ore
 
-        # output is minimum between available feedstocks and output demand
+        # output is minimum between available feedstocks and output set point
         processed_ore_production = np.minimum.reduce(
-            [processed_ore_from_crude_ore, processed_ore_from_electricity, processed_ore_demand]
+            [processed_ore_from_crude_ore, processed_ore_from_electricity, processed_ore_set_point]
         )
 
         # energy consumption
diff --git a/h2integrate/converters/iron/test/test_martin_mine.py b/h2integrate/converters/iron/test/test_martin_mine.py
@@ -41,7 +41,7 @@ def test_iron_mine_performance_outputs(
 
     prob.set_val("comp.electricity_in", [annual_electricity / 8760] * 8760, units="kW")
     prob.set_val("comp.crude_ore_in", [annual_crude_ore / 8760] * 8760, units="t/h")
-    prob.set_val("comp.iron_ore_demand", [ore_rated_capacity] * 8760, units="t/h")
+    prob.set_val("comp.iron_ore_set_point", [ore_rated_capacity] * 8760, units="t/h")
 
     prob.run_model()
     commodity = "iron_ore"
@@ -152,7 +152,7 @@ def test_baseline_iron_ore_costs(plant_config, driver_config, iron_ore_config_ma
 
     prob.set_val("ore_perf.electricity_in", [annual_electricity / 8760] * 8760, units="kW")
     prob.set_val("ore_perf.crude_ore_in", [annual_crude_ore / 8760] * 8760, units="t/h")
-    prob.set_val("ore_perf.iron_ore_demand", [ore_rated_capacity] * 8760, units="t/h")
+    prob.set_val("ore_perf.iron_ore_set_point", [ore_rated_capacity] * 8760, units="t/h")
 
     prob.run_model()
 
diff --git a/h2integrate/converters/natural_gas/natural_gas_cc_ct.py b/h2integrate/converters/natural_gas/natural_gas_cc_ct.py
diff --git a/h2integrate/converters/natural_gas/test/test_natural_gas_models.py b/h2integrate/converters/natural_gas/test/test_natural_gas_models.py
diff --git a/h2integrate/converters/nuclear/nuclear_plant.py b/h2integrate/converters/nuclear/nuclear_plant.py
diff --git a/h2integrate/converters/nuclear/test/test_nuclear_plant.py b/h2integrate/converters/nuclear/test/test_nuclear_plant.py
diff --git a/h2integrate/converters/steel/steel_eaf_base.py b/h2integrate/converters/steel/steel_eaf_base.py
