zen-garden 2.8.3__tar.gz → 2.8.5__tar.gz

{zen_garden-2.8.3 → zen_garden-2.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zen_garden
-Version: 2.8.3
+Version: 2.8.5
 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.3 → zen_garden-2.8.5}/pyproject.toml

@@ -16,7 +16,7 @@ authors = [
   {name = "Giovanni Sansavini"},
   ]
 # do not change version manually! Done by bump2version
-version = "2.8.3"
+version = "2.8.5"
 requires-python= ">=3.11,<3.14"
 description="ZEN-garden is an optimization model of energy systems and value chains."
 readme = "README.md"

zen_garden-2.8.5/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-2.8.3 → zen_garden-2.8.5}/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-2.8.3 → zen_garden-2.8.5}/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