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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: zen_garden-1.14.2.tar.gz
  • Upload date:
  • Size: 131.9 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.2.tar.gz
Algorithm Hash digest
SHA256 42435e51f3f0e129f4a46093a7920578d180e9f875e47c02e5119a65b7bc555a
MD5 57da72789f357f3191422292f112e436
BLAKE2b-256 27c7aaab909a966f4acf96c2ade40e9a2e966fbcd48bbc3f8f3cb6c0e2226659

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

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

File metadata

  • Download URL: zen_garden-1.14.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 89edb53f8e0bb6e60e03f6b52c03cc5dd4d2478eb7ae1898d33f1d74050917d5
MD5 f36e8632acd0d4e4c662755a65e3de4b
BLAKE2b-256 0e72e4d9933c2cfc958056978a0775109f68acd2af70641ae3f89e87e9a207c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for zen_garden-1.14.2-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