zen-garden 2.7.20__tar.gz → 2.8.1__tar.gz

{zen_garden-2.7.20 → zen_garden-2.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zen_garden
-Version: 2.7.20
+Version: 2.8.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.7.20 → zen_garden-2.8.1}/pyproject.toml

@@ -16,7 +16,7 @@ authors = [
   {name = "Giovanni Sansavini"},
   ]
 # do not change version manually! Done by bump2version
-version = "2.7.20"
+version = "2.8.1"
 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.20 → zen_garden-2.8.1}/zen_garden/cli/zen_garden.py

@@ -5,7 +5,6 @@ import os
 # ---------------------------------------------------------------------------
 # Command-line interface
 # ---------------------------------------------------------------------------
-
 def build_parser() -> argparse.ArgumentParser:
     """Build the command-line argument parser for ZEN-garden.
 
@@ -16,7 +15,8 @@ def build_parser() -> argparse.ArgumentParser:
     Command Line Flags:
         --config (str, optional):
             Path to a Python or JSON configuration file. If not provided, the
-            configuration is read from the current working directory.
+            configuration is read from the current working directory. Defaults
+            to "./config.json".
 
         --dataset (str, optional):
             Path to the dataset directory. Overrides
@@ -45,37 +45,43 @@ def build_parser() -> argparse.ArgumentParser:
         "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 "
         "file with --config. Output is always written to the current working "
-        "directory unless overridden."
-    )
+        "directory unless overridden.")
 
-    parser = argparse.ArgumentParser(
-        description=description,
-        add_help=True,
-        usage="zen_garden [options]"
-    )
+    parser = argparse.ArgumentParser(description=description,
+                                     add_help=True,
+                                     usage="zen_garden [options]")
 
+    parser.add_argument("--config",
+                        type=str,
+                        required=False,
+                        default="./config.json",
+                        help="Path to a Python or JSON config file.")
     parser.add_argument(
-        "--config", type=str, required=False, default=None,
-        help="Path to a Python or JSON config file."
-    )
-    parser.add_argument(
-        "--dataset", type=str, required=False, default=None,
+        "--dataset",
+        type=str,
+        required=False,
+        default=None,
         help="Path to the dataset directory. Overrides config.analysis.dataset."
     )
     parser.add_argument(
-        "--folder_output", type=str, required=False, default=None,
-        help="Path to the output directory. Overrides output settings in config."
-    )
+        "--folder_output",
+        type=str,
+        required=False,
+        default=None,
+        help=
+        "Path to the output directory. Overrides output settings in config.")
     parser.add_argument(
-        "--job_index", type=str, required=False, default=None,
+        "--job_index",
+        type=str,
+        required=False,
+        default=None,
         help="Comma-separated list of scenario indices. If omitted, the "
-             "environment variable specified by --job_index_var is used."
-    )
-    parser.add_argument(
-        "--job_index_var", type=str, required=False,
-        default="SLURM_ARRAY_TASK_ID",
-        help="Environment variable for job index."
-    )
+        "environment variable specified by --job_index_var is used.")
+    parser.add_argument("--job_index_var",
+                        type=str,
+                        required=False,
+                        default="SLURM_ARRAY_TASK_ID",
+                        help="Environment variable for job index.")
 
     return parser
 
@@ -106,7 +112,6 @@ def resolve_job_index(job_index:str, job_index_var:str) -> list[int]:
     else:
         return None
 
-
 def cli_zen_garden():
     """
     Entry point for the `zen-garden` command-line interface.
@@ -142,13 +147,15 @@ def cli_zen_garden():
         --job_index_var (str, optional):
             Name of the environment variable containing the job index.
             Defaults to ``SLURM_ARRAY_TASK_ID``.
+                   
+    Returns:
+        None
+
     Examples:
         Basic usage in a command line prompt:
 
-        >>> zen-garden --config=".\config.json" --dataset="1_base_case"
-        
-    Returns:
-        None
+        >>> zen-garden --config=".\\config.json" --dataset="1_base_case"
+
     """    
     # parse command line arguments
     parser = build_parser()
@@ -159,7 +166,7 @@ def cli_zen_garden():
 
     run(
         config=args.config,
-        dataset = args.dataset,
-        folder_output = args.folder_output,
-        job_index = job_index,
-    )
+        dataset=args.dataset,
+        folder_output=args.folder_output,
+        job_index=job_index,
+    )