Simplify debugging of configuration errors during setup

CHANGELOG.md

@@ -29,6 +29,7 @@
   - Remove unused dependencies.
   - Fixes typos for skipped folders.
   - Fixes missing dependencies for `gis` modifier used in new iron mapping tests.
+- Adds `additional_cls_name` kwarg to `BaseConfif.from_dict()` to allow for configuration errors buried in parent or child classes to provide which model had the offending misconfiguration for simpler user debugging.
 
 ## 0.5.1 [December 18, 2025]
 

h2integrate/control/control_rules/pyomo_rule_baseclass.py

@@ -29,7 +29,8 @@ def initialize(self):
 
     def setup(self):
         self.config = PyomoRuleBaseConfig.from_dict(
-            self.options["tech_config"]["model_inputs"]["dispatch_rule_parameters"]
+            self.options["tech_config"]["model_inputs"]["dispatch_rule_parameters"],
+            additional_cls_name=self.__class__.__name__,
         )
 
         self.add_discrete_output(

h2integrate/control/control_strategies/converters/demand_openloop_controller.py

@@ -33,7 +33,8 @@ def setup(self):
                 ``tech_config``.
         """
         self.config = DemandOpenLoopControlBaseConfig.from_dict(
-            self.options["tech_config"]["model_inputs"]["control_parameters"]
+            self.options["tech_config"]["model_inputs"]["control_parameters"],
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/control/control_strategies/converters/flexible_demand_openloop_controller.py

@@ -59,7 +59,8 @@ def setup(self):
         flexible demand output profile, which will be populated in ``compute``.
         """
         self.config = FlexibleDemandOpenLoopConverterControllerConfig.from_dict(
-            self.options["tech_config"]["model_inputs"]["control_parameters"]
+            self.options["tech_config"]["model_inputs"]["control_parameters"],
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/control/control_strategies/passthrough_openloop_controller.py

@@ -23,7 +23,8 @@ class PassThroughOpenLoopController(ControllerBaseClass):
 
     def setup(self):
         self.config = PassThroughOpenLoopControllerConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "control")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "control"),
+            additional_cls_name=self.__class__.__name__,
         )
 
         self.add_input(

h2integrate/control/control_strategies/pyomo_controllers.py

@@ -697,7 +697,8 @@ class HeuristicLoadFollowingController(SimpleBatteryControllerHeuristic):
     def setup(self):
         """Initialize HeuristicLoadFollowingController."""
         self.config = HeuristicLoadFollowingControllerConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "control")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "control"),
+            additional_cls_name=self.__class__.__name__,
         )
 
         self.n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]

h2integrate/control/control_strategies/storage/demand_openloop_controller.py

@@ -167,6 +167,7 @@ def setup(self):
         self.config = DemandOpenLoopStorageControllerConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "control"),
             strict=False,
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/converters/ammonia/ammonia_synloop.py

@@ -142,7 +142,8 @@ class AmmoniaSynLoopPerformanceModel(ResizeablePerformanceModelBaseClass):
     def setup(self):
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
         self.config = AmmoniaSynLoopPerformanceConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 
@@ -416,7 +417,8 @@ def setup(self):
         )
 
         self.config = AmmoniaSynLoopCostConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/converters/ammonia/simple_ammonia_model.py

@@ -35,7 +35,8 @@ def initialize(self):
     def setup(self):
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
         self.config = AmmoniaPerformanceModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         self.add_input("hydrogen_in", val=0.0, shape=n_timesteps, units="kg/h")
         self.add_output("ammonia_out", val=0.0, shape=n_timesteps, units="kg/h")
@@ -100,7 +101,8 @@ class SimpleAmmoniaCostModel(CostModelBaseClass):
 
     def setup(self):
         self.config = AmmoniaCostModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
         # Inputs for cost model configuration

h2integrate/converters/co2/marine/direct_ocean_capture.py

@@ -93,7 +93,8 @@ def initialize(self):
 
     def setup(self):
         self.config = DOCPerformanceConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
         self.add_output(
@@ -167,7 +168,8 @@ def initialize(self):
 
     def setup(self):
         self.config = DOCCostModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
 
         super().setup()

h2integrate/converters/co2/marine/ocean_alkalinity_enhancement.py

@@ -81,7 +81,8 @@ def initialize(self):
 
     def setup(self):
         self.config = OAEPerformanceConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
@@ -265,10 +266,14 @@ def initialize(self):
     def setup(self):
         if "cost" in self.options["tech_config"]["model_inputs"]:
             self.config = OAECostModelConfig.from_dict(
-                merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+                merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+                additional_cls_name=self.__class__.__name__,
             )
         else:
-            self.config = OAECostModelConfig.from_dict(data={})
+            self.config = OAECostModelConfig.from_dict(
+                data={},
+                additional_cls_name=self.__class__.__name__,
+            )
         super().setup()
         self.add_input(
             "mass_sellable_product",
@@ -351,10 +356,14 @@ def initialize(self):
     def setup(self):
         if "cost" in self.options["tech_config"]["model_inputs"]:
             self.config = OAECostModelConfig.from_dict(
-                merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+                merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+                additional_cls_name=self.__class__.__name__,
             )
         else:
-            self.config = OAECostModelConfig.from_dict(data={})
+            self.config = OAECostModelConfig.from_dict(
+                data={},
+                additional_cls_name=self.__class__.__name__,
+            )
         super().setup()
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
         self.add_input(

h2integrate/converters/grid/grid.py

@@ -49,7 +49,8 @@ def initialize(self):
 
     def setup(self):
         self.config = GridPerformanceModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
 
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
@@ -169,7 +170,8 @@ class GridCostModel(CostModelBaseClass):
 
     def setup(self):
         self.config = GridCostModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/converters/hopp/hopp_wrapper.py

@@ -30,6 +30,7 @@ def setup(self):
         self.config = HOPPComponentModelConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
             strict=False,
+            additional_cls_name=self.__class__.__name__,
         )
 
         super().setup()

h2integrate/converters/hydrogen/basic_cost_model.py

@@ -37,7 +37,8 @@ class BasicElectrolyzerCostModel(ElectrolyzerCostBaseClass):
 
     def setup(self):
         self.config = BasicElectrolyzerCostModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/converters/hydrogen/custom_electrolyzer_cost_model.py

@@ -29,7 +29,8 @@ class CustomElectrolyzerCostModel(ElectrolyzerCostBaseClass):
 
     def setup(self):
         self.config = CustomElectrolyzerCostModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
 
         super().setup()

h2integrate/converters/hydrogen/geologic/aspen_surface_processing.py

@@ -78,7 +78,8 @@ class AspenGeoH2SurfacePerformanceModel(GeoH2SurfacePerformanceBaseClass):
 
     def setup(self):
         self.config = AspenGeoH2SurfacePerformanceConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
@@ -238,7 +239,8 @@ class AspenGeoH2SurfaceCostModel(GeoH2SurfaceCostBaseClass):
 
     def setup(self):
         self.config = AspenGeoH2SurfaceCostConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]

h2integrate/converters/hydrogen/geologic/mathur_modified.py

@@ -171,7 +171,11 @@ def setup(self):
             self.target_dollar_year = 2024
 
         config_dict.update({"cost_year": self.target_dollar_year})
-        self.config = GeoH2SubsurfaceCostConfig.from_dict(config_dict, strict=True)
+        self.config = GeoH2SubsurfaceCostConfig.from_dict(
+            config_dict,
+            strict=True,
+            additional_cls_name=self.__class__.__name__,
+        )
 
         super().setup()
 

h2integrate/converters/hydrogen/geologic/simple_natural_geoh2.py

@@ -99,7 +99,8 @@ class NaturalGeoH2PerformanceModel(GeoH2SubsurfacePerformanceBaseClass):
 
     def setup(self):
         self.config = NaturalGeoH2PerformanceConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]

h2integrate/converters/hydrogen/geologic/templeton_serpentinization.py

@@ -76,7 +76,8 @@ class StimulatedGeoH2PerformanceModel(GeoH2SubsurfacePerformanceBaseClass):
     def setup(self):
         n_timesteps = self.options["plant_config"]["plant"]["simulation"]["n_timesteps"]
         self.config = StimulatedGeoH2PerformanceConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/converters/hydrogen/pem_electrolyzer.py

@@ -63,6 +63,7 @@ def setup(self):
         self.config = ECOElectrolyzerPerformanceModelConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
             strict=False,
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
         self.add_output("efficiency", val=0.0, desc="Average efficiency of the electrolyzer")

h2integrate/converters/hydrogen/singlitico_cost_model.py

@@ -31,7 +31,8 @@ class SingliticoCostModel(ElectrolyzerCostBaseClass):
 
     def setup(self):
         self.config = SingliticoCostModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
+            additional_cls_name=self.__class__.__name__,
         )
 
         super().setup()

h2integrate/converters/hydrogen/wombat_model.py

@@ -38,7 +38,8 @@ class WOMBATElectrolyzerModel(ECOElectrolyzerPerformanceModel):
     def setup(self):
         super().setup()
         self.config = WOMBATModelConfig.from_dict(
-            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance")
+            merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
+            additional_cls_name=self.__class__.__name__,
         )
         plant_life = int(self.options["plant_config"]["plant"]["plant_life"])
         self.add_output("capacity_factor", val=0.0, units=None)

h2integrate/converters/iron/iron_dri_base.py

@@ -38,6 +38,7 @@ def setup(self):
         self.config = IronReductionPerformanceBaseConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
             strict=True,
+            additional_cls_name=self.__class__.__name__,
         )
 
         self.add_input(
@@ -319,7 +320,11 @@ def setup(self):
 
         config_dict.update({"cost_year": target_dollar_year})
 
-        self.config = IronReductionCostBaseConfig.from_dict(config_dict, strict=False)
+        self.config = IronReductionCostBaseConfig.from_dict(
+            config_dict,
+            strict=False,
+            additional_cls_name=self.__class__.__name__,
+        )
 
         super().setup()
 

h2integrate/converters/iron/iron_mine.py

@@ -67,6 +67,7 @@ def setup(self):
         self.config = IronMinePerformanceConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
             strict=False,
+            additional_cls_name=self.__class__.__name__,
         )
         self.add_discrete_output(
             "iron_mine_performance", val=pd.DataFrame, desc="iron mine performance results"
@@ -134,7 +135,11 @@ def setup(self):
         config_dict.update({"cost_year": self.target_dollar_year})
         config_dict.update({"plant_life": self.plant_life})
 
-        self.config = IronMineCostConfig.from_dict(config_dict, strict=False)
+        self.config = IronMineCostConfig.from_dict(
+            config_dict,
+            strict=False,
+            additional_cls_name=self.__class__.__name__,
+        )
 
         super().setup()
         self.add_input("LCOE", val=self.config.LCOE, units="USD/MW/h")

h2integrate/converters/iron/iron_plant.py

@@ -66,6 +66,7 @@ def setup(self):
         self.config = IronPlantPerformanceConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
             strict=False,
+            additional_cls_name=self.__class__.__name__,
         )
         self.add_input("iron_ore_in", val=0.0, shape=n_timesteps, units="t/h")
         self.add_discrete_output(
@@ -141,7 +142,10 @@ def setup(self):
         config_dict.update({"cost_year": self.target_dollar_year})
         config_dict.update({"plant_life": self.plant_life})
 
-        self.config = IronPlantCostConfig.from_dict(config_dict)
+        self.config = IronPlantCostConfig.from_dict(
+            config_dict,
+            additional_cls_name=self.__class__.__name__,
+        )
 
         super().setup()
         self.add_input("LCOE", val=self.config.LCOE, units="USD/MW/h")

h2integrate/converters/iron/iron_transport.py

@@ -38,6 +38,7 @@ def setup(self):
         self.config = IronTransportPerformanceConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "performance"),
             strict=False,
+            additional_cls_name=self.__class__.__name__,
         )
         self.add_output("land_transport_distance", val=0.0, units="km")
         self.add_output("water_transport_distance", val=0.0, units="km")
@@ -182,6 +183,7 @@ def setup(self):
         self.config = IronTransportCostConfig.from_dict(
             config_dict,
             strict=True,
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/converters/iron/iron_wrapper.py

@@ -83,6 +83,7 @@ def setup(self):
         self.config = IronConfig.from_dict(
             merge_shared_inputs(self.options["tech_config"]["model_inputs"], "cost"),
             strict=False,
+            additional_cls_name=self.__class__.__name__,
         )
         super().setup()
 

h2integrate/converters/iron/martin_mine_cost_model.py

@@ -70,7 +70,11 @@ def setup(self):
             self.target_dollar_year = 2024
 
         config_dict.update({"cost_year": self.target_dollar_year})
-        self.config = MartinIronMineCostConfig.from_dict(config_dict, strict=True)
+        self.config = MartinIronMineCostConfig.from_dict(
+            config_dict,
+            strict=True,
+            additional_cls_name=self.__class__.__name__,
+        )
 
         super().setup()