Metadata-Version: 2.3
Name: adopt_net0
Version: 0.1.8
Summary: A python package for multi energy system modelling
License: MIT
Author: Jan F. Wiegner
Author-email: j.f.wiegner@uu.nl
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: Pyomo (>=6.7.1)
Requires-Dist: numpy (>=1.26.4)
Requires-Dist: openpyxl (>=3.1.2)
Requires-Dist: pandas (>=2.2.2)
Requires-Dist: pvlib (>=0.10.4)
Requires-Dist: pwlf (>=2.2.1)
Requires-Dist: requests (>=2.31.0)
Requires-Dist: scandir (>=1.10.0)
Requires-Dist: scipy (>=1.13.0)
Requires-Dist: statsmodels (>=0.14.1)
Requires-Dist: timezonefinder (>=6.5.0)
Requires-Dist: tsam (>=2.3.1)
Project-URL: Documentation, https://adopt-net0.readthedocs.io
Project-URL: Homepage, https://github.com/UU-ER/AdOpT-NET0
Project-URL: Repository, https://github.com/UU-ER/AdOpT-NET0
Project-URL: documentation, https://adopt-net0.readthedocs.io
Project-URL: homepage, https://github.com/UU-ER/AdOpT-NET0
Project-URL: issues, https://github.com/UU-ER/AdOpT-NET0/issues
Description-Content-Type: text/markdown

[![Documentation Status](https://readthedocs.org/projects/adopt-net0/badge/?version=latest)](https://adopt-net0.readthedocs.io/en/latest/?badge=latest)
![Testing](https://github.com/UU-ER/AdOpT-NET0/actions/workflows/00deploy.yml/badge.svg?branch=develop)
[![codecov](https://codecov.io/gh/UU-ER/AdOpT-NET0/graph/badge.svg?token=RVR402OGG0)](https://codecov.io/gh/UU-ER/AdOpT-NET0)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI version](https://badge.fury.io/py/adopt-net0.svg)](https://pypi.org/project/adopt-net0/)
[![status](https://joss.theoj.org/papers/12578885161d419241e50c5e745b7a11/status.svg)](https://joss.theoj.org/papers/12578885161d419241e50c5e745b7a11)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13384688.svg)](https://doi.org/10.5281/zenodo.13384688)

# AdOpT-NET0 - Advanced Optimization Tool for Networks and Energy

This is a python package to simulate and optimize multi energy systems. It can 
model conversion technologies and networks for any carrier and optimize the 
design and operation of a multi energy system.

## Installation
You can use the standard utility for installing Python packages by executing the
following in a shell:

```pip install adopt_net0```

Additionally, you need a [solver installed, that is supported by pyomo](https://pyomo.readthedocs.io/en/stable/solving_pyomo_models.html#supported-solvers)
(we recommend gurobi, which has a free academic licence).

Note for mac users: The export of the optimization results require a working
[hdf5 library](https://www.hdfgroup.org/solutions/hdf5/). On windows this should be
installed by default. On mac, you can install it with homebrew:

```brew install hdf5```

## Usage and documentation
The documentation and minimal examples of how to use the package can be found 
[here](https://adopt-net0.readthedocs.io/en/latest/index.html). We also provide a 
[visualization tool](https://resultvisualization.streamlit.app/) that is compatible 
with AdOpT-NET0.

## Dependencies
The package relies heavily on other python packages. Among others this package uses:

- [pyomo](https://github.com/Pyomo/pyomo) for compiling and constructing the model
- [pvlib](https://github.com/pvlib/pvlib-python) for converting climate data into 
  electricity output
- [tsam](https://github.com/FZJ-IEK3-VSA/tsam) for the aggregation of time series

## Credits
This tool was developed at Utrecht University.

