zen-garden 2.8.4__py3-none-any.whl → 2.8.6__py3-none-any.whl

zen_garden/postprocess/results/cache.py

@@ -0,0 +1,52 @@
+import functools
+
+
+class ConditionalCache:
+    """
+    Decorator to conditionally cache method results based on an instance flag.
+    If the flag is True, the method results are cached using functools.cache.
+    Otherwise, the method is called normally without caching.
+
+    ## Usage
+    ```
+    class MyClass:
+        def __init__(self, enable_cache: bool):
+            self.enable_cache = enable_cache
+
+        @ConditionalCache('enable_cache')
+        def my_method(self, ...):
+            # method implementation
+            pass
+    ```
+    """
+
+    def __init__(self, flag_name: str):
+        self.flag_name = flag_name
+
+    def __call__(self, func):
+        self.func = func
+        functools.update_wrapper(self, func)
+        return self
+
+    def __get__(self, instance, owner):
+        if instance is None:
+            return self
+
+        # Check if caching is enabled for this instance and get the bound method
+        enable_cache = getattr(instance, self.flag_name, False)
+        bound_func = self.func.__get__(instance, owner)
+
+        # If caching is disabled, return the original bound method
+        if not enable_cache:
+            return bound_func
+
+        # Check if the cached version already exists
+        cache_attr = f"__cached_{self.func.__name__}"
+        cached_func = getattr(instance, cache_attr, None)
+        if cached_func is not None:
+            return cached_func
+
+        # Create and store the cached version of the method
+        cached_func = functools.cache(bound_func)
+        setattr(instance, cache_attr, cached_func)
+        return cached_func

zen_garden/postprocess/results/results.py

@@ -28,7 +28,7 @@ class Results:
     """
     The Results class is used to extract and process the results of a model run.
     """
-    def __init__(self, path: str):
+    def __init__(self, path: str, enable_cache: bool = True):
         """
         Initializes the Results class.
 
@@ -36,7 +36,7 @@ class Results:
         """
         assert os.path.exists(path), f"The output folder {Path(path).absolute()} does not exist."
         assert len(os.listdir(path)) > 0, f"The output folder {Path(path).absolute()} is empty."
-        self.solution_loader = SolutionLoader(path)
+        self.solution_loader = SolutionLoader(path, enable_cache=enable_cache)
         self.has_scenarios = len(self.solution_loader.scenarios) > 1
         first_scenario = next(iter(self.solution_loader.scenarios.values()))
         self.name = Path(first_scenario.analysis.dataset).name

zen_garden/postprocess/results/solution_loader.py

@@ -14,9 +14,9 @@ import logging
 
 from typing import Optional, Any,Literal
 from enum import Enum
-from functools import cache
 from zen_garden.default_config import Analysis, System, Solver
 from zen_garden.utils import slice_df_by_index
+from .cache import ConditionalCache
 
 class ComponentType(Enum):
     parameter: str = "parameter"
@@ -304,11 +304,12 @@ class SolutionLoader():
     Implementation of a SolutionLoader.
     """
 
-    def __init__(self, path: str) -> None:
+    def __init__(self, path: str, enable_cache: bool = True) -> None:
         self.path = path
         assert len(os.listdir(path)) > 0, f"Path {path} is empty."
         self._scenarios: dict[str, Scenario] = self._read_scenarios()
         self._series_cache: dict[str, "pd.Series[Any]"] = {}
+        self.enable_cache = enable_cache
 
     @property
     def scenarios(self) -> dict[str, Scenario]:
@@ -395,7 +396,7 @@ class SolutionLoader():
         series.index.names = new_index_names
         return series
 
-    @cache
+    @ConditionalCache("enable_cache")
     def get_component_data(
         self,
         scenario: Scenario,
@@ -492,7 +493,7 @@ class SolutionLoader():
 
         return ans
 
-    @cache
+    @ConditionalCache("enable_cache")
     def get_timestep_duration(
         self, scenario: Scenario, component: Component
     ) -> "pd.Series[Any]":
@@ -523,9 +524,7 @@ class SolutionLoader():
 
         return time_step_duration
 
-
-
-    @cache
+    @ConditionalCache("enable_cache")
     def get_timesteps(
         self, scenario: Scenario, component: Component, year: int
     ) -> "pd.Series[Any]":
@@ -556,7 +555,7 @@ class SolutionLoader():
 
         return ans
 
-    @cache
+    @ConditionalCache("enable_cache")
     def get_timesteps_of_years(
         self, scenario: Scenario, ts_type: TimestepType, years: tuple
     ) -> "pd.DataFrame | pd.Series[Any]":
@@ -785,7 +784,6 @@ def get_has_units(h5_file: h5py.File,component_name: str,version: str) -> bool:
         raise ValueError(f"Value {has_units} for has_units not supported.")
     return has_units
 
-@cache
 def get_df_from_path(path: str, component_name: str, version: str, data_type: Literal["dataframe","units"] = "dataframe",index: Optional[tuple[str]] = None) -> "pd.Series[Any]":
     """
     Helper-function that returns a Pandas series given the path of a file and the

zen_garden/utils.py

@@ -21,6 +21,7 @@ import requests
 from importlib.metadata import metadata
 import zipfile
 import io
+import pandas as pd
 
 def setup_logger(level=logging.INFO):
     """ set up logger
@@ -350,10 +351,10 @@ def slice_df_by_index(df,index_tuple) -> dict:
         if key in df.index.names:
             if isinstance(index[key], list):
                 df = df.loc[df.index.get_level_values(key).isin(index[key])]
-            else:
-                if index[key] not in df.index.get_level_values(key):
-                    df = pd.DataFrame(columns=df.columns)  # return empty dataframe if value not in index
+            elif index[key] in df.index.get_level_values(key):
                 df = df.xs(index[key], level=key, drop_level=False)
+            else:
+                df = pd.DataFrame(columns=df.columns)  # return empty dataframe if value not in index
     return df
 
 def get_label_position(obj,label:int):

{zen_garden-2.8.4.dist-info → zen_garden-2.8.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zen_garden
-Version: 2.8.4
+Version: 2.8.6
 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.8.4.dist-info → zen_garden-2.8.6.dist-info}/RECORD

@@ -3,7 +3,7 @@ zen_garden/__main__.py,sha256=Zrz6zr81gXN3_NLPwWz3a-8HiiRgqGx_OzQHarBcxtQ,2508
 zen_garden/default_config.py,sha256=ozz2LBSGSaMH8alEAzh-6ziM9IE9zXM9PfRD3nulAIs,8663
 zen_garden/optimization_setup.py,sha256=Rv_IciR_Y9GF-OaPDDAvTQ2huTuAt94jrWpcDJCQgWQ,42176
 zen_garden/runner.py,sha256=gLjHh3DZbgUAiz5lsnDiSwAZT5RFw52-Pnr1K_nPaMM,7207
-zen_garden/utils.py,sha256=IA52GLccjTbx8pQekc9pAdQD-CO90kfGzkhLBqDcJNs,60519
+zen_garden/utils.py,sha256=GFR-LBIkMA7pDQ46J07mr0ujqyIfNPlI0UVnvBDfHRw,60529
 zen_garden/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zen_garden/cli/zen_example_cli.py,sha256=hCYlAxM5BdphMzXA5LyHmTN3UiYIhMlG7G9sxYi0G_s,1411
 zen_garden/cli/zen_garden_cli.py,sha256=ikiJZoIP4_D-eoNuo4m2f2Z4ydU0sHLDUpCEWn93nnU,6505
@@ -26,15 +26,16 @@ zen_garden/postprocess/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 zen_garden/postprocess/comparisons.py,sha256=uyEtV0Q8_YPzJi4b12DWiqYU-kKJz6I3Li-I7_6RURY,13239
 zen_garden/postprocess/postprocess.py,sha256=0_1iy028iZmvf2egXUFO2ZS13HmkacMt7A5eTI0iCE4,29644
 zen_garden/postprocess/results/__init__.py,sha256=363lzC0uRJ5F42cOEhD9jxMPCioTt8WRt0qwZG0IizY,49
-zen_garden/postprocess/results/results.py,sha256=AkkvPLYotMlDANp2Fn2A3rmZajTX0q_evivxHzTw4CY,40958
-zen_garden/postprocess/results/solution_loader.py,sha256=ChEV4kUi4m5h3Q6B8oxf9wPdEmrH_CNTs5BRNR8UZQs,31252
+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=n3n_n-6hmTjgW6LGSQo8gyI45xp8kn5n1r0Tx5IxCNw,31427
 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
 zen_garden/preprocess/time_series_aggregation.py,sha256=v8xRRk4I9WZ2yi7V3I_Ersj2RV1T2WIKslx8ohkMfWI,32112
 zen_garden/preprocess/unit_handling.py,sha256=y78oxoPVqcA3y9aEiyr0MU5zITf2BPNGVKOfyMhhCvY,63040
-zen_garden-2.8.4.dist-info/entry_points.txt,sha256=FkXXB0MgvdZG_p_zPifgXc0G2GSPJi0NncG3hZ8TXkU,232
-zen_garden-2.8.4.dist-info/licenses/LICENSE.txt,sha256=_kEtxPe9gWOwMzdiy8nLzgABiPdMvUS0kaSCOIrEA_E,1101
-zen_garden-2.8.4.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-zen_garden-2.8.4.dist-info/METADATA,sha256=FAY9z1K0kymryL6LUho1rG3d99p3LcSgxDbmXBwklKY,5648
-zen_garden-2.8.4.dist-info/RECORD,,
+zen_garden-2.8.6.dist-info/entry_points.txt,sha256=FkXXB0MgvdZG_p_zPifgXc0G2GSPJi0NncG3hZ8TXkU,232
+zen_garden-2.8.6.dist-info/licenses/LICENSE.txt,sha256=_kEtxPe9gWOwMzdiy8nLzgABiPdMvUS0kaSCOIrEA_E,1101
+zen_garden-2.8.6.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+zen_garden-2.8.6.dist-info/METADATA,sha256=ukkRuihxJjio9vja2mjtSF96nf-9qRKjIjSvAmzEQxE,5648
+zen_garden-2.8.6.dist-info/RECORD,,