# Vessim
[](https://pypi.org/project/vessim/)
[](https://pypi.org/project/vessim/)
[](https://pypi.org/project/vessim/)
Vessim is a versatile **co-simulation testbed for carbon-aware applications and systems** which connects domain-specific simulators for renewable power generation and energy storage with real software and hardware.
It simulates energy systems that interact with real or simulated computing systems for:
- **Carbon-aware applications**: Simulated microgrids offer real-time visibility and control via APIs, enabling the development of novel applications that interact with their energy system.
- **Energy system composition**: Examine how the integration of solar panels, wind energy, or batteries would affect the energy mix of your datacenters.
- **Digital Twins**: Predict future system states in carbon-aware datacenters, aid decision-making, and assess risks during extreme events like power outages.
- **Quality Assurance**: Apply Vessim in continuous integrating testing or use it to validate software roll-outs in a controlled environment.
Vessim can simulate large numbers of microgrids in parallel, comes with ready-to-use datasets, can execute simulated experiments faster than real-time, and is easily extendable with new simulators of any platform through [Mosaik](https://mosaik.offis.de)'s TCP interface.
**Check out the official [documentation](https://vessim.readthedocs.io/en/latest/)!**
## Example scenario
The scenario below simulates a microgrid consisting of a simulated computing system (which consistently draws 400W), a single producer (a solar power plant who's production is modelled based on a dataset provided by [Solcast](https://solcast.com/)), and a battery. The *Monitor* periodically stores the energy system state.
```python
import vessim as vs
environment = vs.Environment(sim_start="2022-06-15")
monitor = vs.Monitor()
environment.add_microgrid(
actors=[
vs.ComputingSystem(nodes=[vs.MockSignal(value=400)]),
vs.Actor(
name="solar_panel",
signal=vs.HistoricalSignal.load("solcast2022_global", column="Berlin")
),
],
controllers=[monitor],
storage=vs.SimpleBattery(capacity=100),
step_size=60,
)
environment.run(until=24 * 3600) # 24h
monitor.to_csv("result.csv")
```
## 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
```
If you require software-in-the-loop (SiL) capabilities, you should additionally install the `sil` extension:
```
pip install vessim[sil]
```
For complex scenarios that involve custom co-simulation actors we recommend cloning and editing this depository directly.
## Work in progress
Our team at the [Distributed and Operating Systems](https://distributedsystems.berlin/) group at TU Berlin is actively working to improve Vessim.
We are currently working on the following aspects and features:
- **Software-in-the-loop API**: We will soon release a new API for SiL simulations with new examples and better documentation.
- **System Advisor Model (SAM)**: We are working on integrating NREL's [SAM](https://sam.nrel.gov/) as a subsystem in Vessim, allowing for better simulation of solar arrays, wind farms, and other types of renewable energy generators.
- **Flower**: We are working on integrating Vessim into the federated learning framework [Flower](https://flower.ai).
- **Validation**: We are working on validating the accuracy of Vessim compared to real hardware testbeds.
## Datasets
Vessim comes with ready-to-user datasets for solar irradiance and average carbon intensity provided by
<p float="left">
<img src="docs/_static/solcast_logo.png" width="120" />
<span> and </span>
<img src="docs/_static/watttime_logo.png" width="120" />
</p>
We're working on documentation on how to include custom datasets for your simulations.
## Publications
If you use Vessim in your research, please cite our paper:
- Philipp Wiesner, Ilja Behnke, Paul Kilian, Marvin Steinke, and Odej Kao. "[Vessim: A Testbed for Carbon-Aware Applications and Systems.](https://arxiv.org/pdf/2306.09774.pdf)" _3rd Workshop on Sustainable Computer Systems (HotCarbon)_. 2024.
```
@inproceedings{wiesner2024vessim,
title = {Vessim: A Testbed for Carbon-Aware Applications and Systems},
author = {Wiesner, Philipp and Behnke, Ilja and Kilian, Paul and Steinke, Marvin and Kao, Odej},
booktitle = {3rd Workshop on Sustainable Computer Systems (HotCarbon)},
year = {2024},
}
```
For details in Vessim's software-in-the-loop simulation methodology, refer to our journal paper:
- Philipp Wiesner, Marvin Steinke, Henrik Nickel, Yazan Kitana, and Odej Kao. "[Software-in-the-Loop Simulation for Developing and Testing Carbon-Aware Applications.](https://doi.org/10.1002/spe.3275)" _Software: Practice and Experience, 53 (12)_. 2023.
```
@article{wiesner2023sil,
author = {Wiesner, Philipp and Steinke, Marvin and Nickel, Henrik and Kitana, Yazan and Kao, Odej},
title = {Software-in-the-loop simulation for developing and testing carbon-aware applications},
journal = {Software: Practice and Experience},
year = {2023},
volume = {53},
number = {12},
pages = {2362-2376},
doi = {https://doi.org/10.1002/spe.3275}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/dos-group/vessim",
"name": "vessim",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": null,
"keywords": "simulation, energy system, testbed, carbon-aware computing, software-in-the-loop",
"author": "Philipp Wiesner",
"author_email": "wiesner@tu-berlin.de",
"download_url": "https://files.pythonhosted.org/packages/12/ee/05144c954b108a099678b0a7d78b6b2ea548808f7e756756e21b64038fa9/vessim-0.9.1.tar.gz",
"platform": null,
"description": "# Vessim\n\n[](https://pypi.org/project/vessim/)\n\n[](https://pypi.org/project/vessim/)\n[](https://pypi.org/project/vessim/)\n\nVessim is a versatile **co-simulation testbed for carbon-aware applications and systems** which connects domain-specific simulators for renewable power generation and energy storage with real software and hardware.\n\nIt simulates energy systems that interact with real or simulated computing systems for:\n\n- **Carbon-aware applications**: Simulated microgrids offer real-time visibility and control via APIs, enabling the development of novel applications that interact with their energy system.\n- **Energy system composition**: Examine how the integration of solar panels, wind energy, or batteries would affect the energy mix of your datacenters.\n- **Digital Twins**: Predict future system states in carbon-aware datacenters, aid decision-making, and assess risks during extreme events like power outages.\n- **Quality Assurance**: Apply Vessim in continuous integrating testing or use it to validate software roll-outs in a controlled environment.\n\nVessim can simulate large numbers of microgrids in parallel, comes with ready-to-use datasets, can execute simulated experiments faster than real-time, and is easily extendable with new simulators of any platform through [Mosaik](https://mosaik.offis.de)'s TCP interface.\n\n**Check out the official [documentation](https://vessim.readthedocs.io/en/latest/)!**\n\n## Example scenario\n\nThe scenario below simulates a microgrid consisting of a simulated computing system (which consistently draws 400W), a single producer (a solar power plant who's production is modelled based on a dataset provided by [Solcast](https://solcast.com/)), and a battery. The *Monitor* periodically stores the energy system state.\n\n```python\nimport vessim as vs\n\nenvironment = vs.Environment(sim_start=\"2022-06-15\")\n\nmonitor = vs.Monitor()\nenvironment.add_microgrid(\n actors=[\n vs.ComputingSystem(nodes=[vs.MockSignal(value=400)]),\n vs.Actor(\n name=\"solar_panel\",\n signal=vs.HistoricalSignal.load(\"solcast2022_global\", column=\"Berlin\")\n ),\n ],\n controllers=[monitor],\n storage=vs.SimpleBattery(capacity=100),\n step_size=60,\n)\n\nenvironment.run(until=24 * 3600) # 24h\nmonitor.to_csv(\"result.csv\")\n```\n\n\n## Installation\n\nYou can install the [latest release](https://pypi.org/project/vessim/) of Vessim\nvia [pip](https://pip.pypa.io/en/stable/quickstart/):\n\n```\npip install vessim\n```\n\nIf you require software-in-the-loop (SiL) capabilities, you should additionally install the `sil` extension:\n\n```\npip install vessim[sil]\n```\n\nFor complex scenarios that involve custom co-simulation actors we recommend cloning and editing this depository directly.\n\n\n## Work in progress\n\nOur team at the [Distributed and Operating Systems](https://distributedsystems.berlin/) group at TU Berlin is actively working to improve Vessim.\nWe are currently working on the following aspects and features:\n\n- **Software-in-the-loop API**: We will soon release a new API for SiL simulations with new examples and better documentation.\n- **System Advisor Model (SAM)**: We are working on integrating NREL's [SAM](https://sam.nrel.gov/) as a subsystem in Vessim, allowing for better simulation of solar arrays, wind farms, and other types of renewable energy generators.\n- **Flower**: We are working on integrating Vessim into the federated learning framework [Flower](https://flower.ai).\n- **Validation**: We are working on validating the accuracy of Vessim compared to real hardware testbeds.\n\n\n## Datasets\n\nVessim comes with ready-to-user datasets for solar irradiance and average carbon intensity provided by\n\n<p float=\"left\">\n <img src=\"docs/_static/solcast_logo.png\" width=\"120\" />\n <span> and </span>\n <img src=\"docs/_static/watttime_logo.png\" width=\"120\" />\n</p>\n\nWe're working on documentation on how to include custom datasets for your simulations.\n\n\n## Publications\n\nIf you use Vessim in your research, please cite our paper:\n\n- Philipp Wiesner, Ilja Behnke, Paul Kilian, Marvin Steinke, and Odej Kao. \"[Vessim: A Testbed for Carbon-Aware Applications and Systems.](https://arxiv.org/pdf/2306.09774.pdf)\" _3rd Workshop on Sustainable Computer Systems (HotCarbon)_. 2024.\n\n```\n@inproceedings{wiesner2024vessim,\n title = {Vessim: A Testbed for Carbon-Aware Applications and Systems},\n author = {Wiesner, Philipp and Behnke, Ilja and Kilian, Paul and Steinke, Marvin and Kao, Odej},\n booktitle = {3rd Workshop on Sustainable Computer Systems (HotCarbon)},\n year = {2024},\n}\n```\n\nFor details in Vessim's software-in-the-loop simulation methodology, refer to our journal paper:\n\n- Philipp Wiesner, Marvin Steinke, Henrik Nickel, Yazan Kitana, and Odej Kao. \"[Software-in-the-Loop Simulation for Developing and Testing Carbon-Aware Applications.](https://doi.org/10.1002/spe.3275)\" _Software: Practice and Experience, 53 (12)_. 2023.\n\n```\n@article{wiesner2023sil,\n author = {Wiesner, Philipp and Steinke, Marvin and Nickel, Henrik and Kitana, Yazan and Kao, Odej},\n title = {Software-in-the-loop simulation for developing and testing carbon-aware applications},\n journal = {Software: Practice and Experience},\n year = {2023},\n volume = {53},\n number = {12},\n pages = {2362-2376},\n doi = {https://doi.org/10.1002/spe.3275}\n}\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simulator for carbon-aware applications and systems.",
"version": "0.9.1",
"project_urls": {
"Bug Reports": "https://github.com/dos-group/vessim/issues",
"Documentation": "https://github.com/dos-group/vessim",
"Homepage": "https://github.com/dos-group/vessim",
"Repository": "https://github.com/dos-group/vessim"
},
"split_keywords": [
"simulation",
" energy system",
" testbed",
" carbon-aware computing",
" software-in-the-loop"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c6d823d2fba93b0780a8f93e43f7269025029bc79c3d2c66d048cf183794a54",
"md5": "840775e4935ff6c5c4f6d2c87c7569be",
"sha256": "33b31956bfdbe1b083e2cbe2904d253f0413cda7e2435f39a341dd7602fb0246"
},
"downloads": -1,
"filename": "vessim-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "840775e4935ff6c5c4f6d2c87c7569be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 27126,
"upload_time": "2024-09-23T12:48:22",
"upload_time_iso_8601": "2024-09-23T12:48:22.362489Z",
"url": "https://files.pythonhosted.org/packages/2c/6d/823d2fba93b0780a8f93e43f7269025029bc79c3d2c66d048cf183794a54/vessim-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12ee05144c954b108a099678b0a7d78b6b2ea548808f7e756756e21b64038fa9",
"md5": "4b7fd95afffc64cec067a54a94b83eec",
"sha256": "eece42ba8e01de2cef7c7bf74270f8b05d9933d63cef646cbd269539b82a48a1"
},
"downloads": -1,
"filename": "vessim-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "4b7fd95afffc64cec067a54a94b83eec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 26032,
"upload_time": "2024-09-23T12:48:23",
"upload_time_iso_8601": "2024-09-23T12:48:23.559360Z",
"url": "https://files.pythonhosted.org/packages/12/ee/05144c954b108a099678b0a7d78b6b2ea548808f7e756756e21b64038fa9/vessim-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-23 12:48:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dos-group",
"github_project": "vessim",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vessim"
}
JSON
