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

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},
}

Project details


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-1.14.1.tar.gz (132.0 kB view details)

Uploaded Source

Built Distribution

zen_garden-1.14.1-py3-none-any.whl (147.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zen_garden-1.14.1.tar.gz
  • Upload date:
  • Size: 132.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for zen_garden-1.14.1.tar.gz
Algorithm Hash digest
SHA256 11f09d84c8c4c9bb10ff9bac7e20416648d35834ce775a422d375e25656fd4c5
MD5 6ecda0626ce099c8b9cac02190f76d92
BLAKE2b-256 3c1bc6e2f2fed97104926913988447bfb258b4391c97b4c25ecce8d277a9ebc5

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

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

File metadata

  • Download URL: zen_garden-1.14.1-py3-none-any.whl
  • Upload date:
  • Size: 147.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for zen_garden-1.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 37cf16a066229f0a0e1b9540e1957579ddd9e26db29212fe42100bce4d75f856
MD5 f58930fbc657497b1b3bd879135b354e
BLAKE2b-256 260792100c55e779dbc5cbcfafe15465c788caba9edd8a5f07829f448dd9d79a

See more details on using hashes here.

Provenance

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

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

Attestations:

Supported by

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