Metadata-Version: 2.1
Name: vessim
Version: 0.0.3
Summary: A simulator for carbon-aware applications and systems.
Keywords: simulation,energy system,testbed,carbon-aware
Author-email: Philipp Wiesner <wiesner@tu-berlin.de>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: pandas
Requires-Dist: mosaik
Requires-Dist: mosaik-api
Project-URL: Bug Reports, https://github.com/dos-group/vessim/issues
Project-URL: Homepage, https://github.com/dos-group/vessim
Project-URL: Source, https://github.com/dos-group/vessim

# Vessim

[![PyPI version](https://img.shields.io/pypi/v/vessim.svg?color=52c72b)](https://pypi.org/project/vessim/)
![Build](https://github.com/dos-group/vessim/actions/workflows/vessim-ci.yml/badge.svg)
[![License](https://img.shields.io/pypi/l/vessim.svg)](https://pypi.org/project/vessim/)
[![Supported versions](https://img.shields.io/pypi/pyversions/vessim.svg)](https://pypi.org/project/vessim/)

Vessim is a versatile co-simulation testbed for carbon-aware applications and systems.
It lets users connect domain-specific simulators for energy system components like renewable power generation, 
energy storage, and power flow analysis with real software and hardware.

Vessim is in alpha stage and under active development.
Functionality and documentation will improve in the next weeks an months.


## ⚙️ Installation

You can install the [latest release](https://pypi.org/project/vessim/) of Vessim via [pip](https://pip.pypa.io/en/stable/quickstart/):

```
$ pip install vessim
```


## 🚀 Getting started

Vessim uses [Mosaik](https://mosaik.offis.de/) for co-simulation.
To run the example scenario, clone the repository (including all examples) and set up your environment via:

```
$ pip install -e .
```

To execute the fully simulated example scenario, run:
```
$ python examples/scenario_1.py
```


# Development

Install the requirements in a virtual environment:

```
python3 -m venv venv              # create venv
. venv/bin/activate               # activate venv
pip3 install -r requirements.txt  # install dependencies
```

Install & start docker `systemctl start docker`

