Standardized Performance Outputs: Generic Storage & Control #493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

elenya-grant wants to merge 73 commits into NatLabRockies:develop from elenya-grant:converter_baseclass_storage

CHANGELOG.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -37,6 +37,7 @@ @@
       enforced by a newly added test to ensure adherence.
     - Remove `pytest-subtests` as it's incorporated into pytest as of v9, and is an archived project.
     - Added `PerformanceModelBaseClass` and standardized outputs of converter performance models
+    - Updated storage control strategies to output `commodity_set_point` and generic storage performance models to output `commodity_out` and input `commodity_set_point`.
     ## 0.5.1 [December 18, 2025]
@@ Expand Down @@

examples/test/test_all_examples.py

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -258,7 +258,15 @@ def test_ammonia_synloop_example(subtests):
  
            assert pytest.approx(model.prob.get_val("ammonia.CapEx"), rel=1e-6) == 1.15173753e09

        with subtests.test("Check ammonia OpEx"):

            assert pytest.approx(model.prob.get_val("ammonia.OpEx"), rel=1e-4) == 25737370.661763854

            assert pytest.approx(model.prob.get_val("ammonia.OpEx")[0], rel=1e-4) == 25414748.989416014

        with subtests.test("Check ammonia production"):

            assert (

                pytest.approx(

                    model.prob.get_val("ammonia.annual_ammonia_produced", units="t/yr").mean(), rel=1e-4

                )

                == 406333.161

            )

        with subtests.test("Check total adjusted CapEx"):

            assert (

    @@ -273,7 +281,7 @@ def test_ammonia_synloop_example(subtests):
  
                pytest.approx(

                    model.prob.get_val("finance_subgroup_nh3.total_opex_adjusted")[0], rel=1e-6

                )

                == 79744581.00552343

                == 79421959.33317558

            )

        with subtests.test("Check LCOH"):

    @@ -285,7 +293,7 @@ def test_ammonia_synloop_example(subtests):
  
        with subtests.test("Check LCOA"):

            assert (

                pytest.approx(model.prob.get_val("finance_subgroup_nh3.LCOA")[0], rel=1e-6)

                == 1.2310335361130984

                == 1.1022714567388747

            )

h2integrate/control/control_strategies/converters/demand_openloop_controller.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -70,6 +70,6 @@ def compute(self, inputs, outputs): @@
             )
             # Calculate actual output based on demand met and curtailment
-            outputs[f"{commodity}_out"] = (
+            outputs[f"{commodity}_set_point"] = (
                 inputs[f"{commodity}_in"] - outputs[f"{commodity}_unused_commodity"]
             )

h2integrate/control/control_strategies/converters/flexible_demand_openloop_controller.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -297,6 +297,6 @@ def compute(self, inputs, outputs): @@
                 )
             # Calculate actual output based on demand met and curtailment
-            outputs[f"{commodity}_out"] = (
+            outputs[f"{commodity}_set_point"] = (
                 inputs[f"{commodity}_in"] - outputs[f"{commodity}_unused_commodity"]
             )

h2integrate/control/control_strategies/demand_openloop_controller.py

-Original file line number
+Diff line change
@@ Expand Up / @@ -97,7 +97,7 @@ def setup(self): @@
             )
             self.add_output(
-                f"{commodity}_out",
+                f"{commodity}_set_point",
                 val=0.0,
                 shape=(n_timesteps),
                 units=self.config.commodity_units,
@@ Expand Down @@

h2integrate/control/control_strategies/passthrough_openloop_controller.py

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -35,7 +35,7 @@ def setup(self):
  
            )

            self.add_output(

                f"{self.config.commodity_name}_out",

                f"{self.config.commodity_name}_set_point",

                copy_shape=f"{self.config.commodity_name}_in",

                units=self.config.commodity_units,

                desc=f"{self.config.commodity_name} output timeseries from plant after storage",

    @@ -53,7 +53,9 @@ def compute(self, inputs, outputs):
  
            """

            # Assign the input to the output

            outputs[f"{self.config.commodity_name}_out"] = inputs[f"{self.config.commodity_name}_in"]

            outputs[f"{self.config.commodity_name}_set_point"] = inputs[

                f"{self.config.commodity_name}_in"

            ]

        def setup_partials(self):

            """

    @@ -74,7 +76,7 @@ def setup_partials(self):
  
            # Declare partials sparsely for all elements as an identity matrix

            # (diagonal elements are 1.0, others are 0.0)

            self.declare_partials(

                of=f"{self.config.commodity_name}_out",

                of=f"{self.config.commodity_name}_set_point",

                wrt=f"{self.config.commodity_name}_in",

                rows=np.arange(size),

                cols=np.arange(size),

h2integrate/control/control_strategies/storage/demand_openloop_controller.py

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -279,7 +279,7 @@ def compute(self, inputs, outputs):
  
            # initialize outputs

            soc_array = outputs[f"{commodity}_soc"]

            unused_commodity_array = outputs[f"{commodity}_unused_commodity"]

            output_array = outputs[f"{commodity}_out"]

            output_array = outputs[f"{commodity}_set_point"]

            unmet_demand_array = outputs[f"{commodity}_unmet_demand"]

            # Loop through each time step

    @@ -338,7 +338,7 @@ def compute(self, inputs, outputs):
  
                # Record the missed load at the current time step

                unmet_demand_array[t] = max(0.0, (demand_t - output_array[t]))

            outputs[f"{commodity}_out"] = output_array

            outputs[f"{commodity}_set_point"] = output_array

            # Return the SOC

            outputs[f"{commodity}_soc"] = soc_array

h2integrate/control/test/test_openloop_controllers.py

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -72,15 +72,15 @@ def test_pass_through_controller(subtests):
  
        # Run the test

        with subtests.test("Check output"):

            assert pytest.approx(prob.get_val("hydrogen_out"), rel=1e-3) == np.arange(10)

            assert pytest.approx(prob.get_val("hydrogen_set_point"), rel=1e-3) == np.arange(10)

        # Run the test

        with subtests.test("Check derivatives"):

            # check total derivatives using OpenMDAO's check_totals and assert tools

            assert_check_totals(

                prob.check_totals(

                    of=[

                        "hydrogen_out",

                        "hydrogen_set_point",

                    ],

                    wrt=[

                        "hydrogen_in",

    @@ -149,7 +149,7 @@ def test_storage_demand_controller(subtests):
  
        # Run the test

        with subtests.test("Check output"):

            assert pytest.approx([0.5, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]) == prob.get_val(

                "hydrogen_out"

                "hydrogen_set_point"

            )

        with subtests.test("Check curtailment"):

    @@ -241,7 +241,9 @@ def set_up_and_run_problem(config):
  
        # Run the test

        with subtests.test("Check output"):

            assert pytest.approx(prob_ioe.get_val("hydrogen_out")) == prob_rte.get_val("hydrogen_out")

            assert pytest.approx(prob_ioe.get_val("hydrogen_set_point")) == prob_rte.get_val(

                "hydrogen_set_point"

            )

        with subtests.test("Check curtailment"):

            assert pytest.approx(prob_ioe.get_val("hydrogen_unused_commodity")) == prob_rte.get_val(

    @@ -324,7 +326,7 @@ def test_generic_storage_demand_controller(subtests):
  
        # # Run the test

        with subtests.test("Check output"):

            assert pytest.approx([0.5, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]) == prob.get_val(

                "hydrogen_out"

                "hydrogen_set_point"

            )

        with subtests.test("Check curtailment"):

    @@ -396,7 +398,7 @@ def test_demand_converter_controller(subtests):
  
        # # Run the test

        with subtests.test("Check output"):

            assert pytest.approx([0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 5.0, 5.0, 5.0, 5.0]) == prob.get_val(

                "hydrogen_out"

                "hydrogen_set_point"

            )

        with subtests.test("Check curtailment"):

h2integrate/postprocess/test/test_sql_timeseries_to_csv.py

-Original file line number
+Diff line change
@@ Expand Up @@
         res = save_case_timeseries_as_csv(run_example_02_sql_fpath, save_to_file=True)
         with subtests.test("Check number of columns"):
-            assert len(res.columns.to_list()) == 35
+            assert len(res.columns.to_list()) == 36
         with subtests.test("Check number of rows"):
             assert len(res) == 8760
@@ Expand Down @@

h2integrate/storage/simple_generic_storage.py

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
-    import openmdao.api as om
     from attrs import field, define
     from h2integrate.core.utilities import BaseConfig, merge_shared_inputs
+    from h2integrate.core.model_baseclasses import PerformanceModelBaseClass
     @define(kw_only=True)
@@ Expand All / @@ -10,26 +10,48 @@ class SimpleGenericStorageConfig(BaseConfig): @@
         commodity_units: str = field()  # TODO: update to commodity_rate_units
-    class SimpleGenericStorage(om.ExplicitComponent):
-        """
-        Simple generic storage model.
+    class SimpleGenericStorage(PerformanceModelBaseClass):
         """
+        Simple generic storage model that acts as a pass-through component.
+        Note: this storage performance model is intended to be used with the
+        `DemandOpenLoopStorageController` controller.
-        def initialize(self):
-            self.options.declare("tech_config", types=dict)
-            self.options.declare("plant_config", types=dict)
-            self.options.declare("driver_config", types=dict)
+        """
         def setup(self):
-            n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
             self.config = SimpleGenericStorageConfig.from_dict(
                 merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
                 strict=False,
                 additional_cls_name=self.__class__.__name__,
             )
-            commodity_name = self.config.commodity_name
-            commodity_units = self.config.commodity_units
-            self.add_input(f"{commodity_name}_in", val=0.0, shape=n_timesteps, units=commodity_units)
+            self.commodity = self.config.commodity_name
+            self.commodity_rate_units = self.config.commodity_units
+            self.commodity_amount_units = f"({self.commodity_rate_units})*h"
+            super().setup()
+            self.add_input(
+                f"{self.commodity}_set_point",
+                val=0.0,
+                shape=self.n_timesteps,
+                units=self.commodity_rate_units,
+            )
         def compute(self, inputs, outputs):
-            pass
+            # Pass the commodity_out as the commodity_set_point
+            outputs[f"{self.commodity}_out"] = inputs[f"{self.commodity}_set_point"]
+            # Estimate the rated commodity production as the maximum value from the commodity_set_point
+            outputs[f"rated_{self.commodity}_production"] = inputs[f"{self.commodity}_set_point"].max()
+            # Calculate the total and annual commodity produced
+            outputs[f"total_{self.commodity}_produced"] = outputs[f"{self.commodity}_out"].sum()
+            outputs[f"annual_{self.commodity}_produced"] = outputs[
+                f"total_{self.commodity}_produced"
+            ] * (1 / self.fraction_of_year_simulated)
+            # Calculate the maximum commodity production over the simulation
+            max_production = (
+                inputs[f"{self.commodity}_set_point"].max() * self.n_timesteps * (self.dt / 3600)
+            )
+            outputs["capacity_factor"] = outputs[f"total_{self.commodity}_produced"] / max_production

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Standardized Performance Outputs: Generic Storage & Control #493

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Standardized Performance Outputs: Generic Storage & Control #493

Are you sure you want to change the base?

Uh oh!

Standardized Performance Outputs: Generic Storage & Control #493

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!