zen-garden 2.9.0__py3-none-any.whl → 2.9.1__py3-none-any.whl

zen_garden/default_config.py

@@ -142,7 +142,7 @@ class System(Subscriptable):
     knowledge_depreciation_rate: float = 0.1
     reference_year: int = 2024
     unaggregated_time_steps_per_year: int = 8760
-    aggregated_time_steps_per_year: int = 10
+    aggregated_time_steps_per_year: int = 8760
     conduct_time_series_aggregation: bool = False
     optimized_years: int = 1
     interval_between_years: int = 1

zen_garden/postprocess/results/results.py

@@ -76,7 +76,7 @@ class Results:
             if component_name not in scenario.components:
                 logging.warning(f"Component {component_name} not found. If you expected this component to be present, the solution is probably empty and therefore skipped.")
                 return pd.Series()
-            component = scenario.components[component_name]
+            component = scenario.get_component(component_name)
             if data_type == "units" and not component.has_units:
                 return None
             idx = reformat_slicing_index(index,component)
@@ -89,7 +89,7 @@ class Results:
                 scenario = self.solution_loader.scenarios[scenario_name]
                 if component_name not in scenario.components:
                     continue
-                component = scenario.components[component_name]
+                component = scenario.get_component(component_name)
                 if data_type == "units" and not component.has_units:
                     return None
                 idx = reformat_slicing_index(index, component)
@@ -247,7 +247,7 @@ class Results:
             scenario = self.solution_loader.scenarios[scenario_name]
             if component_name not in scenario.components:
                 continue
-            component = scenario.components[component_name]
+            component = scenario.get_component(component_name)
             idx = reformat_slicing_index(index,component)
             scenarios_dict[scenario_name] = self.get_full_ts_per_scenario(
                 scenario,
@@ -363,7 +363,7 @@ class Results:
             scenario = self.solution_loader.scenarios[scenario_name]
             if component_name not in scenario.components:
                 continue
-            component = scenario.components[component_name]
+            component = scenario.get_component(component_name)
             idx = reformat_slicing_index(index, component)
             current_total = self.get_total_per_scenario(
                 scenario, component, year, keep_raw, index = idx
@@ -416,7 +416,7 @@ class Results:
         :return: annuity of the duals
         """
         system = scenario.system
-        discount_rate_component = scenario.components["discount_rate"]
+        discount_rate_component = scenario.get_component("discount_rate")
         # calculate annuity
         discount_rate = self.solution_loader.get_component_data(
             scenario, discount_rate_component
@@ -553,7 +553,7 @@ class Results:
         component = None
         for s in self.solution_loader.scenarios:
             if component_name in self.solution_loader.scenarios[s].components:
-                component = self.solution_loader.scenarios[s].components[component_name]
+                component = self.solution_loader.scenarios[s].get_component(component_name)
                 break
         if component is None:
             return u
@@ -674,7 +674,7 @@ class Results:
         component = None
         for scenario in self.solution_loader.scenarios.values():
             if component_name in scenario.components:
-                component = scenario.components[component_name]
+                component = scenario.get_component(component_name)
                 break
         if component is None:
             logging.warning(f"Component {component_name} not found and the documentation cannot be returned.")
@@ -699,7 +699,7 @@ class Results:
         if component_name not in scenario.components:
             logging.warning(f"Component {component_name} not found and the index names cannot be returned.")
             return []
-        component = scenario.components[component_name]
+        component = scenario.get_component(component_name)
         return component.index_names
 
     def get_years(self, scenario_name: Optional[str] = None) -> list[int]:
@@ -909,11 +909,9 @@ class Results:
         assert component_type in ComponentType.get_component_type_names(), f"Invalid component type: {component_type}. Valid types are: {ComponentType.get_component_type_names()}"
         list_names = []
         for scenario in self.solution_loader.scenarios:
-            for component in self.solution_loader.scenarios[scenario].components:
-                component_name = self.solution_loader.scenarios[scenario].components[component].name
-                component_type_specific = self.solution_loader.scenarios[scenario].components[component].component_type.name
-                if component_name not in list_names and component_type_specific == component_type:
-                    list_names.append(component)
+            for cn in self.solution_loader.scenarios[scenario].component_types[component_type]:
+                if cn not in list_names:
+                    list_names.append(cn)
         return list_names
 
 

zen_garden/postprocess/results/solution_loader.py

@@ -129,7 +129,7 @@ class Scenario():
     folder.
     """
 
-    def __init__(self, path: str, name: str, base_scenario: str, default_ureg: pint.UnitRegistry) -> None:
+    def __init__(self, path: str, name: str, base_scenario: str) -> None:
         self.name = name
         self.base_name = base_scenario
         self._exists = True
@@ -138,8 +138,9 @@ class Scenario():
         self._system: System = self._read_system()
         self._solver: Solver = self._read_solver()
         self._benchmarking: dict[str,Any] = self._read_benchmarking()
-        self._ureg = self._read_ureg(default_ureg)
-        self._components: dict[str, Component] = self._read_components()
+        self._component_types: dict[str, list[str]] = None
+        self._components: dict[str, Component] = None
+        self._read_components()
 
     def _read_analysis(self) -> Analysis:
         analysis_path = os.path.join(self.path, "analysis.json")
@@ -177,12 +178,12 @@ class Scenario():
         else:
             return {}
 
-    def _read_ureg(self,default_ureg) -> pint.UnitRegistry:
-
+    def _read_ureg(self) -> pint.UnitRegistry:
+        
         # suppress pint output about redefining units
         logging.getLogger('pint').setLevel(logging.ERROR)
         # load ureg
-        ureg = copy.copy(default_ureg)
+        ureg = copy.copy(pint.UnitRegistry())
         unit_path = os.path.join(self.path, "unit_definitions.txt")
         if os.path.exists(unit_path):
             ureg.load_definitions(unit_path)
@@ -220,7 +221,7 @@ class Scenario():
             raise KeyError(f"Year {year} not in optimized years {all_years}.")
         return ts
 
-    def _read_components(self) -> dict[str, Component]:
+    def _read_components(self) -> dict[str, list[str]]:
         """
         Create the component instances.
 
@@ -228,8 +229,12 @@ class Scenario():
         the component. Furthermore, the timestep name and type are derived by checking
         if any of the defined time steps name is in the index of the dataframe.
         """
-        ans: dict[str, Component] = {}
-
+        component_types: dict[str,list[str]] = {t: [] for t in ComponentType.get_component_type_names()}
+        components:dict[str,dict] = {}
+        
+        if not self._exists:
+            return component_types
+        
         if self.has_rh:
             mf_name = [i for i in os.listdir(self.path) if "MF_" in i][0]
             component_folder = os.path.join(self.path, mf_name)
@@ -241,36 +246,22 @@ class Scenario():
 
             if not os.path.exists(file_path):
                 continue
-
+            
             h5_file = h5py.File(file_path)
-            version = get_solution_version(self)
-            for component_name in h5_file.keys():
-                index_names = get_index_names(h5_file,component_name,version)
-                time_index = set(index_names).intersection(set(TimestepType.get_time_steps_names()))
-                timestep_name = time_index.pop() if len(time_index) > 0 else None
-                timestep_type = TimestepType.get_time_step_type(timestep_name)
-
-                doc = get_doc(h5_file,component_name,version)
-
-                has_units = get_has_units(h5_file,component_name,version)
-
-                ans[component_name] = Component(
-                    component_name,
-                    component_type,
-                    index_names,
-                    timestep_type,
-                    timestep_name,
-                    file_name,
-                    doc,
-                    has_units
-                )
+            component_types[component_type.value] = list(h5_file.keys())
+            components.update({cn: {"component_type": component_type, "file_name": file_name, "file_path": file_path} for cn in h5_file.keys()})
 
-        return ans
+        self._component_types = component_types
+        self._components = components
 
     @property
-    def components(self) -> dict[str, Component]:
+    def components(self) -> dict[str, dict]:
         return self._components
 
+    @property
+    def component_types(self) -> dict[str, list[str]]:
+        return self._component_types
+    
     @property
     def analysis(self) -> Analysis:
         return self._analysis
@@ -297,11 +288,48 @@ class Scenario():
 
     @property
     def ureg(self) -> pint.UnitRegistry:
-        return self._ureg
+        return self._read_ureg()
 
     @property
     def exists(self) -> bool:
         return self._exists
+    
+    def get_component(self, component_name: str) -> Component:
+        """
+        Method that returns a component given its name.
+        :param component_name: The name of the component.
+        :return: The component.
+        """
+        if component_name not in self.components:
+            raise KeyError(f"Component {component_name} not found in scenario {self.name}. Available components: {list(self.components.keys())}")
+        
+        component_info = self.components[component_name]
+        component_type = component_info["component_type"]
+        file_name = component_info["file_name"]
+
+        h5_file = h5py.File(component_info["file_path"])
+        version = get_solution_version(self)
+        index_names = get_index_names(h5_file,component_name,version)
+        time_index = set(index_names).intersection(set(TimestepType.get_time_steps_names()))
+        timestep_name = time_index.pop() if len(time_index) > 0 else None
+        timestep_type = TimestepType.get_time_step_type(timestep_name)
+
+        doc = get_doc(h5_file,component_name,version)
+
+        has_units = get_has_units(h5_file,component_name,version)
+
+        ans = Component(
+            component_name,
+            component_type,
+            index_names,
+            timestep_type,
+            timestep_name,
+            file_name,
+            doc,
+            has_units
+        )
+        return ans
+
 
 class SolutionLoader():
     """
@@ -312,6 +340,7 @@ class SolutionLoader():
         self.path = path
         assert len(os.listdir(path)) > 0, f"Path {path} is empty."
         self._scenarios: dict[str, Scenario] = self._read_scenarios()
+        self._ureg = get_first_scenario(self._scenarios).ureg
         self._series_cache: dict[str, "pd.Series[Any]"] = {}
         self.enable_cache = enable_cache
 
@@ -467,14 +496,13 @@ class SolutionLoader():
         """
         scenarios_json_path = os.path.join(self.path, "scenarios.json")
         ans: dict[str, Scenario] = {}
-        default_ureg = pint.UnitRegistry()
         with open(scenarios_json_path, "r") as f:
             scenario_configs = json.load(f)
 
         if len(scenario_configs) == 1:
             scenario_name = "none"
             scenario_path = self.path
-            ans[scenario_name] = Scenario(scenario_path, scenario_name, "",default_ureg)
+            ans[scenario_name] = Scenario(scenario_path, scenario_name, "")
         else:
             for scenario_id, scenario_config in scenario_configs.items():
                 scenario_name = f"scenario_{scenario_id}"
@@ -494,7 +522,7 @@ class SolutionLoader():
                     )
 
                 scenario = Scenario(
-                    scenario_path, scenario_name, base_scenario, default_ureg
+                    scenario_path, scenario_name, base_scenario
                 )
 
                 if scenario.exists:

{zen_garden-2.9.0.dist-info → zen_garden-2.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zen_garden
-Version: 2.9.0
+Version: 2.9.1
 Summary: ZEN-garden is an optimization model of energy systems and value chains.
 Author: Alissa Ganter, Johannes Burger, Francesco De Marco, Lukas Kunz, Lukas Schmidt-Engelbertz, Christoph Funke, Paolo Gabrielli, Giovanni Sansavini
 Author-email: Jacob Mannhardt <zen-garden@ethz.ch>

{zen_garden-2.9.0.dist-info → zen_garden-2.9.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 zen_garden/__init__.py,sha256=vFEb5EpCLlaX_sxgqcwQge-HUzdq7nUGyXcol6F7dhE,722
 zen_garden/__main__.py,sha256=Zrz6zr81gXN3_NLPwWz3a-8HiiRgqGx_OzQHarBcxtQ,2508
-zen_garden/default_config.py,sha256=vys7xf_s0GrH9SSLCkDF3im6FONb15JE73wLT9yZ3_o,8426
+zen_garden/default_config.py,sha256=Ti8MWdwB_9um5w8gk36vxUF3CVL5xYJAPMbhRqE8XYw,8428
 zen_garden/optimization_setup.py,sha256=--nxXr28v2p1EHwqFIREXAhesUg5MfOTPwHWImFSOnM,35441
 zen_garden/runner.py,sha256=8wGfLhevbeMMf5qDDsLdfI3fO78KCHFwSk23_xDcBVc,6739
 zen_garden/utils.py,sha256=GFR-LBIkMA7pDQ46J07mr0ujqyIfNPlI0UVnvBDfHRw,60529
@@ -28,8 +28,8 @@ zen_garden/postprocess/comparisons.py,sha256=uyEtV0Q8_YPzJi4b12DWiqYU-kKJz6I3Li-
 zen_garden/postprocess/postprocess.py,sha256=r8aQf1oXX2SwKj1tj_Wc186RQtAF-G4fKH_qBtTIFHg,28377
 zen_garden/postprocess/results/__init__.py,sha256=363lzC0uRJ5F42cOEhD9jxMPCioTt8WRt0qwZG0IizY,49
 zen_garden/postprocess/results/cache.py,sha256=t-1P7k9EVkSxR1oB1NIodux3JbfhBhxxwgRytcQ8vjQ,1592
-zen_garden/postprocess/results/results.py,sha256=S21h0Unf4l3a8WD0UFvn8IeMgDxKitZRaiX7iLvJnL0,41012
-zen_garden/postprocess/results/solution_loader.py,sha256=VfmkEipLG5im3wm0aYA5qqg1ZvRutfZbvFeUvwZRoh8,31700
+zen_garden/postprocess/results/results.py,sha256=u1ZXkGrantxP6r3sj2Y2MNAtd7R4OotM_qd8OjA1iuE,40759
+zen_garden/postprocess/results/solution_loader.py,sha256=23o2MBp_HPaF9IqJvgLqAii8_cYcAoHpTuyze8_ppBc,32764
 zen_garden/preprocess/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zen_garden/preprocess/extract_input_data.py,sha256=PWKdel7s488SELseyAaoFkwXpzJU4MZg0pW0wO2ZHoI,51523
 zen_garden/preprocess/parameter_change_log.py,sha256=WNhLYTyuaFkUl_e4QH36W1chpqg00m7zg__PawPogAY,387
@@ -38,8 +38,8 @@ zen_garden/preprocess/unit_handling.py,sha256=08sFQMR6hjKos_ANgfGIc3BLm3lCMmpuu1
 zen_garden/wrapper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zen_garden/wrapper/operation_scenarios.py,sha256=qfEMqnEc5qA10lO-rVGzVqvz_6MBNDIjZlrCncCpNJo,8499
 zen_garden/wrapper/utils.py,sha256=YY-HSPQ2UPwws5PAumvBzq4tp-yUcbUqILkTyI_Z2TU,16352
-zen_garden-2.9.0.dist-info/entry_points.txt,sha256=xtDb4g8Mho0X9g55niFwiJlajN8XGdTrLkhgyBz5hhs,304
-zen_garden-2.9.0.dist-info/licenses/LICENSE.txt,sha256=_kEtxPe9gWOwMzdiy8nLzgABiPdMvUS0kaSCOIrEA_E,1101
-zen_garden-2.9.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-zen_garden-2.9.0.dist-info/METADATA,sha256=cbzz6CgzUOOrk4tYepRyEAWhbUA3gpi8vwYglryQ8wQ,5796
-zen_garden-2.9.0.dist-info/RECORD,,
+zen_garden-2.9.1.dist-info/entry_points.txt,sha256=xtDb4g8Mho0X9g55niFwiJlajN8XGdTrLkhgyBz5hhs,304
+zen_garden-2.9.1.dist-info/licenses/LICENSE.txt,sha256=_kEtxPe9gWOwMzdiy8nLzgABiPdMvUS0kaSCOIrEA_E,1101
+zen_garden-2.9.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+zen_garden-2.9.1.dist-info/METADATA,sha256=1nVRgcKuUZ_kfn0UzVHO26go9rTRCdP3HRCB52MYKFU,5796
+zen_garden-2.9.1.dist-info/RECORD,,