Skip to main content

ZEN-garden is an optimization model of energy systems and value chains.

Project description

ZEN-garden

Python Version from PEP 621 TOML

GitHub Release PyPI - Version

GitHub Actions Workflow Status Endpoint Badge Read the Docs

GitHub forks

drawing

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 at ETH Zurich.


Quick Start

To get started with ZEN-garden, you can follow the instructions in the installation guide.

If you want to use ZEN-garden without working on the codebase, run the following command:

pip install zen-garden

If you want to work on the codebase, fork and clone the repository and install the package in editable mode. More information on how to install the package in editable mode can be found in the installation guide.

Documentation

Please refer to the documentation of the ZEN-garden framework on Read-the-Docs.

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 of our repo.

News

Review recent modifications outlined in the changelog.

Citing ZEN-garden

If you use ZEN-garden for research, please cite

Jacob Mannhardt, Alissa Ganter, Johannes Burger, Francesco De Marco, Lukas Kunz, Lukas Schmidt-Engelbertz, Paolo Gabrielli, Giovanni Sansavini (2025). ZEN-garden: Optimizing energy transition pathways with user-oriented data handling. https://www.sciencedirect.com/science/article/pii/S2352711025000263

and use the following BibTeX:

@article{ZENgarden2025,
title = {ZEN-garden: Optimizing Energy Transition Pathways with User-Oriented Data Handling},
author = {Mannhardt, Jacob and Ganter, Alissa and Burger, Johannes and De Marco, Francesco and Kunz, Lukas and {Schmidt-Engelbertz}, Lukas and Gabrielli, Paolo and Sansavini, Giovanni},
year = {2025},
journal = {SoftwareX},
volume = {29},
pages = {102059},
issn = {2352-7110},
doi = {10.1016/j.softx.2025.102059},
}

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zen_garden-2.5.2.tar.gz (134.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zen_garden-2.5.2-py3-none-any.whl (148.7 kB view details)

Uploaded Python 3

File details

Details for the file zen_garden-2.5.2.tar.gz.

File metadata

  • Download URL: zen_garden-2.5.2.tar.gz
  • Upload date:
  • Size: 134.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for zen_garden-2.5.2.tar.gz
Algorithm Hash digest
SHA256 a6be3f075ad94833e6596be2fa2207ee00e8dfa1cade0bd5a3a4d6afdc5ba33a
MD5 6c88bcbdc881c27b7215acfd20892967
BLAKE2b-256 2b1ed584afed13906517496a9fd1bc1eb5e612f0d67a73771d070989f6114dfc

See more details on using hashes here.

Provenance

The following attestation bundles were made for zen_garden-2.5.2.tar.gz:

Publisher: pytest_with_conda.yml on ZEN-universe/ZEN-garden

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zen_garden-2.5.2-py3-none-any.whl.

File metadata

  • Download URL: zen_garden-2.5.2-py3-none-any.whl
  • Upload date:
  • Size: 148.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for zen_garden-2.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 def60bde728d1d727a012699f2df6ef727057fd9401a925e679c9bfb21e734a1
MD5 a9090302dec9d6922a526b734fbda485
BLAKE2b-256 bc1f0329f3f3d9d83d9e89db30173c641be60d624c3ab5911ecfce68cf090e98

See more details on using hashes here.

Provenance

The following attestation bundles were made for zen_garden-2.5.2-py3-none-any.whl:

Publisher: pytest_with_conda.yml on ZEN-universe/ZEN-garden

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page