Metadata-Version: 2.1
Name: zen_garden
Version: 1.7.7
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},
}
```

