Metadata-Version: 2.4
Name: DES_sim
Version: 1.0.2
Author-email: Leroy Tomas <leroy.tomas@hs-offenburg.de>
License-Expression: MIT
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)

This project uses the mosaik package to simulate heat pump in conjuction with a CHP unit to meet the heat and electricity demand of a housing district.

## Installation

To get started first create a new conda env with:
conda create --name myenv python=3.10.13

Second, activate the environment and install the package:
conda activate myenv
pip install .

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

After that you can run the simulation script from the project root with:
python main_sim.py

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

### Installing dependencies
Install the recommended dependencies with:
```
pip install . docs

```
## Documentation

The documentation for the individual models is available [here](docs/index.md)

## Recommended vscode-extensions
- GitLens -Git supercharged: Nice graphical git support
- autopep8: Autoformatting in pep8. Install and press (strg+alt+F)
- Better Comments: Highlighting of comments syntax
- Code Spell Checker: Spelling checker
- Drawio.io Integration: UML-Diagrams, etc. in vs-code
- Edit csv: Editing csv files like tables in excel
- Rainbow CSV: Color highlighting in csv files
- autoDocstring: Python Docstring generator (Generates Docstrings in different styles (Google, sphinx, etc...))

## Note:
**src** Folder: 
- Do not rename it to "code". It will cause name clashes with the internal python module "code".
