Metadata-Version: 2.4
Name: DES_sim
Version: 1.1.0
Author-email: Leroy Tomas <leroy.tomas@hs-offenburg.de>
License: MIT
        BSD-3-Clause
        MIT AND (Apache-2.0 OR BSD-2-Clause)
        MIT OR GPL-2.0-or-later OR (FSFUL AND BSD-2-Clause)
        GPL-3.0-only WITH Classpath-Exception-2.0 OR BSD-3-Clause
        LicenseRef-Special-License OR CC0-1.0 OR Unlicense
        LicenseRef-Proprietary
Keywords: DES,mosaik,simulation,HP,CHP,PV
Requires-Python: ==3.10.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools<81
Requires-Dist: mosaik==3.2.0
Requires-Dist: mosaik-api==3.0.3
Requires-Dist: mosaik-api-v3==3.0.9
Requires-Dist: mosaik-heatpump==1.0.1
Requires-Dist: mosaik-pv==1.2.1
Requires-Dist: mosaik-pvlib==1.0
Requires-Dist: mosaik-csv
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: plotly==5.24.1
Requires-Dist: nest_asyncio
Requires-Dist: nbformat==5.10.4
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Provides-Extra: opti
Requires-Dist: ipykernel; extra == "opti"
Requires-Dist: ipynbname; extra == "opti"
Requires-Dist: tqdm; extra == "opti"
Requires-Dist: pyDOE; extra == "opti"
Provides-Extra: docs
Requires-Dist: sphinx==7.4.5; extra == "docs"
Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "docs"
Requires-Dist: m2r2==0.3.3.post2; extra == "docs"
Dynamic: license-file

# District Energy System (DES)

[![PyPI version](https://badge.fury.io/py/DES-sim.svg)](https://pypi.org/project/DES-sim/)
![Python](https://img.shields.io/badge/python-3.10-blue)

A Python package for simulating district heating networks using the [mosaik](https://pypi.org/project/mosaik/) co-simulation framework. Models include heat pumps, CHP units, boilers, PV systems, battery storage, and thermal tanks.

Developed at Hochschule Offenburg – Institute for Sustainable Energy Systems [INES](https://www.hs-offenburg.de/forschung/institute/ines-institut-fuer-nachhaltige-energiesysteme).

## Installation

Create a new conda environment:

```
conda create --name des_sim python=3.10.13
conda activate des_sim
pip install DES-sim
```

*(If you plan to modify the core models in the `src/` folder, install in editable mode instead using `pip install -e .`)*

## Usage

Run the simulation from the project root:

```
python main_sim.py
```

Configuration is pulled from `data/inputs/input_params.json`, and outputs are saved to `data/outputs/`.

## Documentation

The documentation for the individual models is available [here](https://github.com/ltomas1/DES.sim/tree/main/docs).
