zen-garden 1.7.5__tar.gz

zen_garden-1.7.5/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Reliability and Risk Engineering, ETH Zurich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zen_garden-1.7.5/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.1
+Name: zen_garden
+Version: 1.7.5
+Summary: ZEN-garden is an optimization model of energy systems and value chains.
+Author-email: Jacob Mannhardt <jmannhardt@ethz.ch>, Alissa Ganter <aganter@ethz.ch>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: xarray
+Requires-Dist: cython
+Requires-Dist: numpy<=1.26.4
+Requires-Dist: pandas>=2.2
+Requires-Dist: scipy
+Requires-Dist: pint
+Requires-Dist: tables
+Requires-Dist: pydantic
+Requires-Dist: tsam
+Requires-Dist: h5py
+Requires-Dist: filelock
+Requires-Dist: ordered-set
+Requires-Dist: pyogrio
+Requires-Dist: psutil
+Requires-Dist: linopy<=0.3.10
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: coverage ; extra == "dev"
+Requires-Dist: sphinx==7.3.7 ; extra == "docs"
+Requires-Dist: myst-parser==3.0.1 ; extra == "docs"
+Requires-Dist: sphinx-book-theme==1.1.3 ; extra == "docs"
+Requires-Dist: pydata-sphinx-theme==0.15.4 ; extra == "docs"
+Requires-Dist: sphinx-reredirects==0.1.4 ; extra == "docs"
+Requires-Dist: nbsphinx==0.9.4 ; extra == "docs"
+Requires-Dist: nbsphinx-link==1.3.0 ; extra == "docs"
+Requires-Dist: gurobipy ; extra == "gurobipy"
+Project-URL: Documentation, https://zen-garden.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/ZEN-universe/ZEN-garden
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: gurobipy
+
+# ZEN-garden
+
+[![GitHub Release](https://img.shields.io/github/v/release/ZEN-universe/ZEN-garden)](https://github.com/ZEN-universe/ZEN-garden/releases)
+[![GitHub Tag](https://img.shields.io/github/v/tag/ZEN-universe/ZEN-garden)](https://github.com/ZEN-universe/ZEN-garden/tags)
+[![GitHub forks](https://img.shields.io/github/forks/ZEN-universe/ZEN-garden)](https://github.com/ZEN-universe/ZEN-garden/forks)
+
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ZEN-universe/ZEN-garden/pytest_with_conda.yml)](https://github.com/ZEN-universe/ZEN-garden/actions)
+[![Endpoint Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/jacob-mannhardt/30d479a5b4c591a63b7b0f41abbce6a0/raw/zen_garden_coverage.json)](https://github.com/ZEN-universe/ZEN-garden/actions)
+
+[![Read the Docs](https://img.shields.io/readthedocs/zen-garden?logo=readthedocs)](https://zen-garden.readthedocs.io/en/latest/index.html)
+
+
+[//]: # (<table><tr><td valign="center"> )
+
+[//]: # (  <img align="left" height="25px" src="https://github.com/RRE-ETH/ZEN-garden/actions/workflows/pytest_with_conda.yml/badge.svg?branch=development"> )
+
+[//]: # (  <img align="left" height="25px" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/jafluri/5d0d79e86182cd9ccd785d824b1f9ac7/raw/zen_coverage.json">)
+
+[//]: # (  <b> &#40;Development Branch&#41; </b>)
+
+[//]: # (</td></tr></table>)
+
+[//]: # (<hr style="height: 5px; background-color: black;">)
+
+<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. 
+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. 
+
+ZEN-garden is developed by the [Reliability and Risk Engineering Laboratory](https://www.rre.ethz.ch/) at ETH Zurich.
+<hr style="height: 5px; background-color: black;">
+
+## Documentation
+Please refer to the documentation of the ZEN-garden framework [on Read-the-Docs](https://zen-garden.readthedocs.io/en/latest/). 
+To get started with ZEN-garden, you can follow the instructions in the [installation guide](https://zen-garden.readthedocs.io/en/latest/files/installation.html).
+
+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.
+
+## News
+Review recent modifications outlined in the [changelog](https://github.com/ZEN-universe/ZEN-garden/blob/main/CHANGELOG.md).
+
+## Citing ZEN-garden
+If you use ZEN-garden for research please cite
+
+Ganter Alissa, Gabrielli Paolo, Sansavini, Giovanni (2024).
+Near-term infrastructure rollout and investment strategies for net-zero hydrogen supply chains 
+2024. https://doi.org/10.1016/j.rser.2024.114314
+
+and use the following BibTeX:
+```
+@article{GANTER2024114314,
+author = {Alissa Ganter and Paolo Gabrielli and Giovanni Sansavini}
+title = {Near-term infrastructure rollout and investment strategies for net-zero hydrogen supply chains},
+journal = {Renewable and Sustainable Energy Reviews},
+volume = {194},
+pages = {114314},
+year = {2024},
+issn = {1364-0321},
+doi = {https://doi.org/10.1016/j.rser.2024.114314},
+url = {https://www.sciencedirect.com/science/article/pii/S1364032124000376},
+}
+```
+

zen_garden-1.7.5/README.md

@@ -0,0 +1,67 @@
+# ZEN-garden
+
+[![GitHub Release](https://img.shields.io/github/v/release/ZEN-universe/ZEN-garden)](https://github.com/ZEN-universe/ZEN-garden/releases)
+[![GitHub Tag](https://img.shields.io/github/v/tag/ZEN-universe/ZEN-garden)](https://github.com/ZEN-universe/ZEN-garden/tags)
+[![GitHub forks](https://img.shields.io/github/forks/ZEN-universe/ZEN-garden)](https://github.com/ZEN-universe/ZEN-garden/forks)
+
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ZEN-universe/ZEN-garden/pytest_with_conda.yml)](https://github.com/ZEN-universe/ZEN-garden/actions)
+[![Endpoint Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/jacob-mannhardt/30d479a5b4c591a63b7b0f41abbce6a0/raw/zen_garden_coverage.json)](https://github.com/ZEN-universe/ZEN-garden/actions)
+
+[![Read the Docs](https://img.shields.io/readthedocs/zen-garden?logo=readthedocs)](https://zen-garden.readthedocs.io/en/latest/index.html)
+
+
+[//]: # (<table><tr><td valign="center"> )
+
+[//]: # (  <img align="left" height="25px" src="https://github.com/RRE-ETH/ZEN-garden/actions/workflows/pytest_with_conda.yml/badge.svg?branch=development"> )
+
+[//]: # (  <img align="left" height="25px" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/jafluri/5d0d79e86182cd9ccd785d824b1f9ac7/raw/zen_coverage.json">)
+
+[//]: # (  <b> &#40;Development Branch&#41; </b>)
+
+[//]: # (</td></tr></table>)
+
+[//]: # (<hr style="height: 5px; background-color: black;">)
+
+<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. 
+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. 
+
+ZEN-garden is developed by the [Reliability and Risk Engineering Laboratory](https://www.rre.ethz.ch/) at ETH Zurich.
+<hr style="height: 5px; background-color: black;">
+
+## Documentation
+Please refer to the documentation of the ZEN-garden framework [on Read-the-Docs](https://zen-garden.readthedocs.io/en/latest/). 
+To get started with ZEN-garden, you can follow the instructions in the [installation guide](https://zen-garden.readthedocs.io/en/latest/files/installation.html).
+
+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.
+
+## News
+Review recent modifications outlined in the [changelog](https://github.com/ZEN-universe/ZEN-garden/blob/main/CHANGELOG.md).
+
+## Citing ZEN-garden
+If you use ZEN-garden for research please cite
+
+Ganter Alissa, Gabrielli Paolo, Sansavini, Giovanni (2024).
+Near-term infrastructure rollout and investment strategies for net-zero hydrogen supply chains 
+2024. https://doi.org/10.1016/j.rser.2024.114314
+
+and use the following BibTeX:
+```
+@article{GANTER2024114314,
+author = {Alissa Ganter and Paolo Gabrielli and Giovanni Sansavini}
+title = {Near-term infrastructure rollout and investment strategies for net-zero hydrogen supply chains},
+journal = {Renewable and Sustainable Energy Reviews},
+volume = {194},
+pages = {114314},
+year = {2024},
+issn = {1364-0321},
+doi = {https://doi.org/10.1016/j.rser.2024.114314},
+url = {https://www.sciencedirect.com/science/article/pii/S1364032124000376},
+}
+```

zen_garden-1.7.5/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "zen_garden"
+authors = [
+  {name = "Jacob Mannhardt", email = "jmannhardt@ethz.ch"},
+  {name = "Alissa Ganter", email = "aganter@ethz.ch"}
+  ]
+version = "1.7.5"
+requires-python= ">=3.10"
+description="ZEN-garden is an optimization model of energy systems and value chains."
+readme = "README.md"
+license = { file = "LICENSE.txt" }
+
+dependencies = [
+    "xarray",
+    "cython",
+    "numpy<=1.26.4",
+    "pandas>=2.2",
+    "scipy",
+    "pint",
+    "tables",
+    "pydantic",
+    "tsam",
+    "h5py",
+    "filelock",
+    "ordered-set",
+    "pyogrio",
+    "psutil",
+    "linopy<=0.3.10",
+]
+
+[project.optional-dependencies]
+docs = [
+    "sphinx==7.3.7",
+    "myst-parser==3.0.1",
+    "sphinx-book-theme==1.1.3",
+    "pydata-sphinx-theme==0.15.4",
+    "sphinx-reredirects==0.1.4",
+    "nbsphinx==0.9.4",
+    "nbsphinx-link==1.3.0",
+]
+
+dev = [
+    "pytest",
+    "coverage",
+]
+
+gurobipy = ["gurobipy"]
+
+[project.urls]
+Homepage = "https://github.com/ZEN-universe/ZEN-garden"
+Documentation = "https://zen-garden.readthedocs.io/en/latest/"

zen_garden-1.7.5/zen_garden/__init__.py

@@ -0,0 +1,11 @@
+from . import model
+from . import postprocess
+from . import preprocess
+from .utils import get_inheritors
+
+from .model.objects.element import Element
+from .model.optimization_setup import OptimizationSetup
+
+# set the element classes of the EnergySystem class
+inheritors = get_inheritors(Element)
+OptimizationSetup.dict_element_classes.update({klass.__name__: klass for klass in inheritors})

zen_garden-1.7.5/zen_garden/__main__.py

@@ -0,0 +1,83 @@
+"""
+:Title:        ZEN-GARDEN
+:Created:      September-2022
+:Authors:      Janis Fluri (janis.fluri@id.ethz.ch),
+              Alissa Ganter (aganter@ethz.ch),
+              Jacob Mannhardt (jmannhardt@ethz.ch)
+:Organization: Laboratory of Reliability and Risk Engineering, ETH Zurich
+
+Compilation  of the optimization problem.
+"""
+from ._internal import main
+import importlib.util
+import argparse
+import sys
+import os
+import zen_garden.model.default_config as default_config
+import json
+from zen_garden.utils import copy_dataset_example
+
+def run_module(args=None):
+    """
+    Runs the main function of ZEN-Garden
+
+    :param args: Arguments to parse
+    """
+    if args is None:
+        args = sys.argv[1:]
+
+    # parse the args
+    description = "Run ZEN garden with a given config file. Per default, the config file will be read out from the " \
+                  "current working directory. You can specify a config file with the --config argument. However, " \
+                  "note that the output directory will always be the current working directory, independent of the " \
+                  "dataset specified in the config file."
+    parser = argparse.ArgumentParser(description=description, add_help=True, usage="usage: python -m zen_garden [-h] [--config CONFIG] [--dataset DATASET] [--job_index JOB_INDEX] [--job_index_var JOB_INDEX_VAR] [--example EXAMPLE]")
+    # TODO make json config default
+    parser.add_argument("--config", required=False, type=str, default="./config.py", help="The config file used to run the pipeline, "
+                                                                                        "defaults to config.py in the current directory.")
+    parser.add_argument("--dataset", required=False, type=str, default=None, help="Path to the dataset used for the run. IMPORTANT: This will overwrite the "
+                                                                                  "config.analysis['dataset'] attribute of the config file!")
+    parser.add_argument("--job_index", required=False, type=str, default=None, help="A comma separated list (no spaces) of indices of the scenarios to run, if None, all scenarios are run in sequence")
+    parser.add_argument("--job_index_var", required=False, type=str, default="SLURM_ARRAY_TASK_ID", help="Try to read out the job index from the environment variable specified here. "
+                                                                                                         "If both --job_index and --job_index_var are specified, --job_index will be used.")
+    parser.add_argument("--example", required=False, type=str, default=None, help="Run an example scenario. The argument should be the name of a dataset example in documentation/dataset_examples. This command will copy the dataset and the config to the current folder and run the example.")
+
+    args = parser.parse_args(args)
+
+    # copy example dataset and run example #TODO so far doesn't work because dataset_examples are not part of the package but outside
+    if args.example is not None:
+        example_path_cwd,config_path_cwd = copy_dataset_example(args.example)
+        args.dataset = example_path_cwd
+        args.config = config_path_cwd
+
+    if not os.path.exists(args.config):
+        args.config = args.config.replace(".py", ".json")
+
+    # change working directory to the directory of the config file
+    config_path, config_file = os.path.split(args.config)
+    os.chdir(config_path)
+    ### import the config
+    if config_file.endswith(".py"):
+        spec = importlib.util.spec_from_file_location("module", config_file)
+        module = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(module)
+        config = module.config
+    else:
+        with open(args.config, "r") as f:
+            config = default_config.Config(**json.load(f))
+
+    ### get the job index
+    job_index = args.job_index
+    if job_index is None:
+        if (job_index := os.environ.get(args.job_index_var)) is not None:
+            job_index = int(job_index)
+    else:
+        job_index = [int(i) for i in job_index.split(",")]
+
+    ### run
+    main(config=config, dataset_path=args.dataset, job_index=job_index)
+
+
+if __name__ == "__main__":
+
+    run_module()

zen_garden-1.7.5/zen_garden/_internal.py

@@ -0,0 +1,103 @@
+"""
+:Title:        ZEN-GARDEN
+:Created:      October-2021
+:Authors:      Alissa Ganter (aganter@ethz.ch),
+               Jacob Mannhardt (jmannhardt@ethz.ch)
+:Organization: Laboratory of Reliability and Risk Engineering, ETH Zurich
+
+Compilation  of the optimization problem.
+"""
+import cProfile
+import importlib.util
+import logging
+import os
+from collections import defaultdict
+import importlib
+
+from .model.optimization_setup import OptimizationSetup
+from .postprocess.postprocess import Postprocess
+from .utils import setup_logger, InputDataChecks, StringUtils, ScenarioUtils, OptimizationError
+from .preprocess.unit_handling import Scaling
+
+# we setup the logger here
+setup_logger()
+
+
+def main(config, dataset_path=None, job_index=None):
+    """
+    This function runs ZEN garden,
+    it is executed in the __main__.py script
+
+    :param config: A config instance used for the run
+    :param dataset_path: If not None, used to overwrite the config.analysis["dataset"]
+    :param job_index: The index of the scenario to run or a list of indices, if None, all scenarios are run in sequence
+    """
+
+    # print the version
+    version = importlib.metadata.version("zen-garden")
+    logging.info(f"Running ZEN-garden version: {version}")
+
+    # prevent double printing
+    logging.propagate = False
+
+    # overwrite the path if necessary
+    if dataset_path is not None:
+        # logging.info(f"Overwriting dataset to: {dataset_path}")
+        config.analysis["dataset"] = dataset_path
+    logging.info(f"Optimizing for dataset {config.analysis['dataset']}")
+    # get the abs path to avoid working dir stuff
+    config.analysis["dataset"] = os.path.abspath(config.analysis['dataset'])
+    config.analysis["folder_output"] = os.path.abspath(config.analysis['folder_output'])
+
+    ### SYSTEM CONFIGURATION
+    input_data_checks = InputDataChecks(config=config, optimization_setup=None)
+    input_data_checks.check_dataset()
+    input_data_checks.read_system_file(config)
+    input_data_checks.check_technology_selections()
+    input_data_checks.check_year_definitions()
+    # overwrite default system and scenario dictionaries
+    scenarios,elements = ScenarioUtils.get_scenarios(config,job_index)
+    # get the name of the dataset
+    model_name, out_folder = StringUtils.setup_model_folder(config.analysis,config.system)
+    # clean sub-scenarios if necessary
+    ScenarioUtils.clean_scenario_folder(config,out_folder)
+    ### ITERATE THROUGH SCENARIOS
+    for scenario, scenario_dict in zip(scenarios, elements):
+        # FORMULATE THE OPTIMIZATION PROBLEM
+        # add the scenario_dict and read input data
+        optimization_setup = OptimizationSetup(config, scenario_dict=scenario_dict, input_data_checks=input_data_checks)
+        # get rolling horizon years
+        steps_horizon = optimization_setup.get_optimization_horizon()
+        # iterate through horizon steps
+        for step in steps_horizon:
+            StringUtils.print_optimization_progress(scenario,steps_horizon,step,system=config.system)
+            # overwrite time indices
+            optimization_setup.overwrite_time_indices(step)
+            # create optimization problem
+            optimization_setup.construct_optimization_problem()
+            #TODO scaling algorithm
+            if config.solver["use_scaling"]:
+                optimization_setup.scaling.run_scaling()
+            else:
+                optimization_setup.scaling.analyze_numerics()
+            # SOLVE THE OPTIMIZATION PROBLEM
+            optimization_setup.solve()
+            # break if infeasible
+            if not optimization_setup.optimality:
+                # write IIS
+                optimization_setup.write_IIS()
+                raise OptimizationError(optimization_setup.model.termination_condition)
+            if config.solver["use_scaling"]:
+                optimization_setup.scaling.re_scale()
+            # save new capacity additions and cumulative carbon emissions for next time step
+            optimization_setup.add_results_of_optimization_step(step)
+            # EVALUATE RESULTS
+            # create scenario name, subfolder and param_map for postprocessing
+            scenario_name, subfolder, param_map = StringUtils.generate_folder_path(
+                config = config,scenario = scenario,scenario_dict=scenario_dict,steps_horizon=steps_horizon,step=step
+            )
+            # write results
+            Postprocess(optimization_setup, scenarios=config.scenarios, subfolder=subfolder,
+                            model_name=model_name, scenario_name=scenario_name, param_map=param_map)
+    logging.info("--- Optimization finished ---")
+    return optimization_setup

zen_garden-1.7.5/zen_garden/model/__init__.py

@@ -0,0 +1 @@
+from .default_config import Config

zen_garden-1.7.5/zen_garden/model/default_config.py

@@ -0,0 +1,178 @@
+"""
+:Title:        ZEN-GARDEN
+:Created:      October-2021
+:Authors:      Alissa Ganter (aganter@ethz.ch)
+:Organization: Laboratory of Reliability and Risk Engineering, ETH Zurich
+
+Default configuration. Changes from the default values are specified in config.py (folders data/tests) and system.py (individual datasets)
+"""
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, Optional, Union
+
+
+class Subscriptable(BaseModel, extra="allow"):
+    def __getitem__(self, __name: str) -> Any:
+        return getattr(self, __name)
+
+    def __setitem__(self, __name: str, __value: Any) -> None:
+        setattr(self, __name, __value)
+
+    def keys(self) -> Any:
+        return self.model_dump().keys()
+
+    def update(self, new_values: dict[Any, Any]) -> None:
+        for key, val in new_values.items():
+            if isinstance(val, dict):
+                getattr(self, key).update(val)
+            else:
+                setattr(self, key, val)
+
+    def items(self) -> Any:
+        return self.model_dump().items()
+
+    def values(self) -> Any:
+        return self.model_dump().values()
+
+    def __iter__(self) -> Any:
+        self.fix_keys = list(self.model_dump().keys())
+        self.i = 0
+        return self
+
+    def __next__(self) -> Any:
+        if self.i < len(self.fix_keys):
+            ans = self.fix_keys[self.i]
+            self.i += 1
+            return ans
+        else:
+            del self.i
+            del self.fix_keys
+            raise StopIteration
+
+
+class Subsets(Subscriptable):
+    set_carriers: list[str] = []
+    set_technologies: dict[str, list[str]] | list[str] = {
+        "set_conversion_technologies": ["set_retrofitting_technologies"],
+        "set_transport_technologies": [],
+        "set_storage_technologies": [],
+    }
+
+
+class HeaderDataInputs(Subscriptable):
+    set_nodes: str = "node"
+    set_edges: str = "edge"
+    set_location: str = "location"
+    set_time_steps: str = "time"  # IMPORTANT: time must be unique
+    set_time_steps_operation: str = "time_operation"
+    set_time_steps_storage_level: str = "time_storage_level"
+    set_time_steps_yearly: str = "year"  # IMPORTANT: year must be unique
+    set_time_steps_yearly_entire_horizon: str = "year_entire_horizon"
+    set_carriers: str = "carrier"
+    set_input_carriers: str = "carrier"
+    set_output_carriers: str = "carrier"
+    set_time_steps_storage: str = "time_storage_level"
+    set_dependent_carriers: str = "carrier"
+    set_elements: str = "element"
+    set_conversion_technologies: str = "technology"
+    set_transport_technologies: str = "technology"
+    set_transport_technologies_loss_exponential: str = "technology"
+    set_storage_technologies: str = "technology"
+    set_technologies: str = "technology"
+    set_technologies_existing: str = "technology_existing"
+    set_capacity_types: str = "capacity_type"
+
+class System(Subscriptable):
+    model_config = ConfigDict(extra="allow")
+    set_carriers: list[str] = []
+    set_capacity_types: list[str] = ["power", "energy"]
+    set_conversion_technologies: list[str] = []
+    set_storage_technologies: list[str] = []
+    set_retrofitting_technologies: list[str] = []
+    storage_periodicity: bool = True
+    set_transport_technologies: list[str] = []
+    set_transport_technologies_loss_exponential: list[str] = []
+    double_capex_transport: bool = False
+    set_nodes: list[str] = []
+    exclude_parameters_from_TSA: bool = True
+    conduct_scenario_analysis: bool = False
+    run_default_scenario: bool = True
+    clean_sub_scenarios: bool = False
+    total_hours_per_year: int = 8760
+    knowledge_depreciation_rate: float = 0.1
+    enforce_selfish_behavior: bool = False
+    reference_year: int = 2023
+    unaggregated_time_steps_per_year: int = 8760
+    aggregated_time_steps_per_year: int = 10
+    conduct_time_series_aggregation: bool = True
+    optimized_years: int = 3
+    interval_between_years: int = 1
+    use_rolling_horizon: bool = False
+    years_in_rolling_horizon: int = 5
+    years_in_decision_horizon: int = 1
+    use_capacities_existing: bool = True
+
+class SolverOptions(Subscriptable):
+    pass
+
+class Solver(Subscriptable):
+    name: str = "highs"
+    solver_options: SolverOptions = SolverOptions()
+    check_unit_consistency: bool = True
+    solver_dir: str = ".//outputs//solver_files"
+    keep_files: bool = False
+    io_api: str = "lp"
+    add_duals: bool = False
+    recommend_base_units: bool = False
+    immutable_unit: list[str] = []
+    range_unit_exponents: dict[str, int] = {"min": -1, "max": 1, "step_width": 1}
+    rounding_decimal_points: int = 5
+    rounding_decimal_points_ts: int = 4
+    linear_regression_check: dict[str, float] = {
+        "eps_intercept": 0.1,
+        "epsRvalue": 1 - (1e-5),
+    }
+    rounding_decimal_points_units: int = 6
+    round_parameters: bool = True
+    rounding_decimal_points_capacity: int = 4
+    analyze_numerics: bool = True
+    use_scaling: bool = True
+    scaling_include_rhs: bool = False
+    scaling_algorithm: Union[list[str],str] = ["geom","geom","geom"]
+
+
+
+class TimeSeriesAggregation(Subscriptable):
+    slv: Solver = Solver()
+    clusterMethod: str = "hierarchical"
+    solver: str = slv.name
+    hoursPerPeriod: int = 1
+    extremePeriodMethod: Optional[str] = "None"
+    rescaleClusterPeriods: bool = False
+    representationMethod: str = "meanRepresentation"
+    resolution: int = 1
+    segmentation: bool = False
+    noSegments: int = 12
+
+class Analysis(Subscriptable):
+    dataset: str = ""
+    objective: str = "total_cost"
+    sense: str = "minimize"
+    transport_distance: str = "Euclidean"
+    subsets: Subsets = Subsets()
+    header_data_inputs: HeaderDataInputs = HeaderDataInputs()
+    time_series_aggregation: TimeSeriesAggregation = TimeSeriesAggregation()
+    folder_output: str = "./outputs/"
+    overwrite_output: bool = True
+    output_format: str = "h5"
+    write_results_yml: bool = False
+    max_output_size_mb: int = 500
+    folder_name_system_specification: str = "system_specification"
+    earliest_year_of_data: int = 1900
+
+class Config(Subscriptable):
+    analysis: Analysis = Analysis()
+    solver: Solver = Solver()
+    system: System = System()
+
+    scenarios: dict[str, Any] = {"": {}}

zen_garden-1.7.5/zen_garden/model/objects/__init__.py

@@ -0,0 +1,2 @@
+from .carrier import *
+from .technology import *

zen_garden-1.7.5/zen_garden/model/objects/carrier/__init__.py

@@ -0,0 +1,13 @@
+"""==========
+:Title:        ZEN-GARDEN
+:Created:      March-2022
+:Authors:      Alissa Ganter (aganter@ethz.ch)
+:Organization: Laboratory of Reliability and Risk Engineering, ETH Zurich
+
+  function that loads all classes and subclasses of carrier directory.
+"""
+from pathlib import Path
+
+# register the subclasses
+modules = Path(__file__).parent.glob("*.py")
+__all__ = [f.stem for f in modules if f.is_file()]