zen-garden 2.7.13__tar.gz → 2.7.15__tar.gz

{zen_garden-2.7.13 → zen_garden-2.7.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zen_garden
-Version: 2.7.13
+Version: 2.7.15
 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, Paolo Gabrielli, Giovanni Sansavini
 Author-email: Jacob Mannhardt <zen-garden@ethz.ch>
@@ -62,7 +62,7 @@ Provides-Extra: vis
 
 <img src="https://github.com/ZEN-universe/ZEN-garden/assets/114185605/d6a9aca9-74b0-4a82-8295-43e6a78b8450" alt="drawing" width="200"/>
 
-Welcome to the ZEN-garden! ZEN-garden is an optimization model of energy systems and value chains. 
+Welcome to the ZEN-garden! ZEN-garden is an optimization framework for energy transition pathways. 
 It is currently used to model the electricity system, hydrogen value chains, and carbon capture, storage and utilization (CCUS) value chains. 
 However, it is designed to be modular and flexible, and can be extended to model other types of energy systems, value chains or other network-based systems. 
 
@@ -80,12 +80,7 @@ If you want to work on the codebase, fork and clone the repository and install t
 
 ## Documentation
 Please refer to the documentation of the ZEN-garden framework [on Read-the-Docs](https://zen-garden.readthedocs.io/en/latest/). 
-
-In the file `documentation/how_to_ZEN-garden.md`, you can find additional information on how to use the framework. 
-The `documentation/dataset_creation_tutorial.md` file contains a tutorial on how to create a simple dataset for the framework. 
-Additionally, example datasets are available in the `dataset_examples` folder.
-
-More in-depth manuals are available in the [discussions forum](https://github.com/ZEN-universe/ZEN-garden/discussions) of our repo.
+Additionally, example datasets are available in the `dataset_examples` folder and described in [the documentation](https://zen-garden.readthedocs.io/en/latest/files/zen_garden_in_detail/dataset_examples.html).
 
 ## News
 Review recent modifications outlined in the [changelog](https://github.com/ZEN-universe/ZEN-garden/blob/main/CHANGELOG.md).

{zen_garden-2.7.13 → zen_garden-2.7.15}/README.md

@@ -12,7 +12,7 @@
 
 <img src="https://github.com/ZEN-universe/ZEN-garden/assets/114185605/d6a9aca9-74b0-4a82-8295-43e6a78b8450" alt="drawing" width="200"/>
 
-Welcome to the ZEN-garden! ZEN-garden is an optimization model of energy systems and value chains. 
+Welcome to the ZEN-garden! ZEN-garden is an optimization framework for energy transition pathways. 
 It is currently used to model the electricity system, hydrogen value chains, and carbon capture, storage and utilization (CCUS) value chains. 
 However, it is designed to be modular and flexible, and can be extended to model other types of energy systems, value chains or other network-based systems. 
 
@@ -30,12 +30,7 @@ If you want to work on the codebase, fork and clone the repository and install t
 
 ## Documentation
 Please refer to the documentation of the ZEN-garden framework [on Read-the-Docs](https://zen-garden.readthedocs.io/en/latest/). 
-
-In the file `documentation/how_to_ZEN-garden.md`, you can find additional information on how to use the framework. 
-The `documentation/dataset_creation_tutorial.md` file contains a tutorial on how to create a simple dataset for the framework. 
-Additionally, example datasets are available in the `dataset_examples` folder.
-
-More in-depth manuals are available in the [discussions forum](https://github.com/ZEN-universe/ZEN-garden/discussions) of our repo.
+Additionally, example datasets are available in the `dataset_examples` folder and described in [the documentation](https://zen-garden.readthedocs.io/en/latest/files/zen_garden_in_detail/dataset_examples.html).
 
 ## News
 Review recent modifications outlined in the [changelog](https://github.com/ZEN-universe/ZEN-garden/blob/main/CHANGELOG.md).

{zen_garden-2.7.13 → zen_garden-2.7.15}/pyproject.toml

@@ -15,7 +15,7 @@ authors = [
   {name = "Giovanni Sansavini"},
   ]
 # do not change version manually! Done by bump2version
-version = "2.7.13"
+version = "2.7.15"
 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.7.13 → zen_garden-2.7.15}/zen_garden/postprocess/results/results.py

@@ -673,6 +673,27 @@ class Results:
             return ""
         return component.doc
 
+    def get_index_names(self, component_name: str, scenario_name: Optional[str] = None) -> list[str]:
+        """
+        Docstring for get_index_names
+        
+        :param self: Description
+        :param component_name: Description
+        :type component_name: str
+        :param scenario_name: Description
+        :type scenario_name: Optional[str]
+        :return: Description
+        :rtype: list[str]
+        """
+        if scenario_name is None:
+            scenario_name = next(iter(self.solution_loader.scenarios.keys()))
+        scenario = self.solution_loader.scenarios[scenario_name]
+        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]
+        return component.index_names
+
     def get_years(self, scenario_name: Optional[str] = None) -> list[int]:
         """
         Extracts the years of a given Scenario. If no scenario is given, a random one is taken.

{zen_garden-2.7.13 → zen_garden-2.7.15}/zen_garden/postprocess/results/solution_loader.py

@@ -10,10 +10,13 @@ import h5py  # type: ignore
 import pint
 import pandas as pd
 import numpy as np
+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
 
 class ComponentType(Enum):
     parameter: str = "parameter"
@@ -788,6 +791,8 @@ def get_df_from_path(path: str, component_name: str, version: str, data_type: Li
 
     if check_if_v1_leq_v2(version,"v0"):
         pd_read = pd.read_hdf(path, component_name + f"/{data_type}")
+        if len(index) > 0:
+            pd_read = slice_df_by_index(pd_read,index)
     else:
         if data_type == "dataframe":
             try:

{zen_garden-2.7.13 → zen_garden-2.7.15}/zen_garden/utils.py

@@ -262,6 +262,33 @@ def reformat_slicing_index(index, component) -> tuple[str]:
 
     return ref_index
 
+def slice_df_by_index(df,index_tuple) -> dict:
+    """ recreates the slicing index from a tuple of strings and slices the dataframe accordingly
+    :param df: dataframe to be sliced
+    :param index_tuple: tuple of strings representing the slicing index
+    :return: sliced dataframe
+    """
+    index = {}
+    for index_str in index_tuple:
+        if " in " in index_str:
+            key, value_str = index_str.split(" in ")
+            key = key.strip("'")
+            value = eval(value_str)
+        elif " == " in index_str:
+            key, value_str = index_str.split(" == ")
+            key = key.strip("'")
+            value = eval(value_str)
+        else:
+            continue
+        index[key] = value
+    for key in index:
+        if key in df.index.names:
+            if isinstance(index[key], list):
+                df = df.loc[df.index.get_level_values(key).isin(index[key])]
+            else:
+                df = df.xs(index[key], level=key, drop_level=False)
+    return df
+
 def get_label_position(obj,label:int):
     """ Get dict of index and coordinate for variable or constraint labels."""
     name_element = obj.get_name_by_label(int(label))