zen-garden 2.8.0__tar.gz → 2.8.2__tar.gz

{zen_garden-2.8.0 → zen_garden-2.8.2}/PKG-INFO

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

@@ -16,7 +16,7 @@ authors = [
   {name = "Giovanni Sansavini"},
   ]
 # do not change version manually! Done by bump2version
-version = "2.8.0"
+version = "2.8.2"
 requires-python= ">=3.11,<3.14"
 description="ZEN-garden is an optimization model of energy systems and value chains."
 readme = "README.md"
@@ -78,6 +78,6 @@ Zenodo = "https://zenodo.org/api/records/13385110"
 addopts = "-n auto"
 
 [project.scripts]
-zen-garden = "zen_garden.cli.zen_garden:cli_zen_garden"
-zen-visualization = "zen_garden.cli.zen_visualization:cli_zen_visualization"
-zen-example = "zen_garden.cli.zen_example:cli_zen_example"
+zen-garden = "zen_garden.cli.zen_garden_cli:create_zen_garden_cli"
+zen-visualization = "zen_garden.cli.zen_visualization_cli:create_zen_visualization_cli"
+zen-example = "zen_garden.cli.zen_example_cli:create_zen_example_cli"

{zen_garden-2.8.0 → zen_garden-2.8.2}/zen_garden/__init__.py

@@ -7,8 +7,9 @@ from .optimization_setup import OptimizationSetup
 from .runner import run
 from .postprocess.results.results import Results
 from .utils import download_example_dataset
+from .postprocess.comparisons import compare_model_values, compare_configs, compare_dicts
 
-__all__ = ["run", "Results", "download_example_dataset"]
+__all__ = ["run", "Results", "download_example_dataset", "compare_model_value", "compare_configs", "compare_dicts"]
 
 
 # set the element classes of the EnergySystem class

zen_garden-2.8.0/zen_garden/cli/zen_example.py → zen_garden-2.8.2/zen_garden/cli/zen_example_cli.py

@@ -2,7 +2,7 @@ import argparse
 import sys
 from zen_garden.utils import download_example_dataset
 
-def cli_zen_example():
+def create_zen_example_cli():
     """ 
     Entry point for the `zen-example` command-line interface.
 

zen_garden-2.8.0/zen_garden/cli/zen_garden.py → zen_garden-2.8.2/zen_garden/cli/zen_garden_cli.py

@@ -39,8 +39,8 @@ def build_parser() -> argparse.ArgumentParser:
     Returns:
         argparse.ArgumentParser: An argument parser configured for the
         ZEN-Garden command-line interface.
-    """
 
+    """
     description = (
         "Run ZEN-Garden with a given config file. By default, the config file "
         "is read from the current working directory. You may specify a config "
@@ -103,8 +103,8 @@ def resolve_job_index(job_index:str, job_index_var:str) -> list[int]:
     Returns:
         list[int] | None: List of job indices to run in the current instance of
             ZEN-garden, or ``None`` if no job index is specified.
-    """
 
+    """
     if job_index:
         return [int(i) for i in job_index.split(",")]
     elif ((env_value := os.environ.get(job_index_var)) is not None):
@@ -112,7 +112,7 @@ def resolve_job_index(job_index:str, job_index_var:str) -> list[int]:
     else:
         return None
 
-def cli_zen_garden():
+def create_zen_garden_cli():
     """
     Entry point for the `zen-garden` command-line interface.
     
@@ -154,9 +154,9 @@ def cli_zen_garden():
     Examples:
         Basic usage in a command line prompt:
 
-        >>> zen-garden --config=".\config.json" --dataset="1_base_case"
-    """
+        >>> zen-garden --config=".\\config.json" --dataset="1_base_case"
 
+    """    
     # parse command line arguments
     parser = build_parser()
     args = parser.parse_args()

zen_garden-2.8.0/zen_garden/cli/zen_visualization.py → zen_garden-2.8.2/zen_garden/cli/zen_visualization_cli.py

@@ -1,6 +1,6 @@
 from zen_temple.main import parse_arguments_and_run
 
-def cli_zen_visualization():
+def create_zen_visualization_cli():
     """
     Entry point for the `zen-visualization` command-line interface.
 

{zen_garden-2.8.0 → zen_garden-2.8.2}/zen_garden/utils.py

@@ -351,6 +351,8 @@ def slice_df_by_index(df,index_tuple) -> dict:
             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
                 df = df.xs(index[key], level=key, drop_level=False)
     return df