Skip to main content

A simulator for carbon-aware applications and systems.

Project description

Vessim

PyPI version Tests License Supported versions

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 and months.

Installation

If you are using Vessim for the first time, we recommend to clone and install this repository, so you have all code and examples at hand:

pip install -e .

Alternatively, you can also install our latest release via pip:

pip install vessim

Getting started

To execute our exemplary co-simulation scenario, run:

python examples/cosim_example.py

Software-in-the-Loop (SiL) simulation allows real computing systems to interact with Vessim at runtime. We're currently working on better documentation on how to set up a full SiL scenario, but you can experiment with the existing functionality by installing the "sil" extension (pip install vessim[sil]) and running:

python examples/sil_example.py

Work in progress

Our team at the Distributed and Operating Systems group at TU Berlin is actively working to improve Vessim. We are currently working on the following aspects and features:

  • Better documentation: You can find the current WiP documentation here
  • Improving the scenario API: We currently heavily rely on Mosaik's scenario interface for defining experiment, but want to offer a more opinionated, high-level API to improve usability.
  • Software-in-the-loop (SiL) capabilities: The current SiL implementation is focussed around our exemplary use case presented in our journal paper. We want this to become more general purpose, so users can implement custom interfaces for the communication of computing and energy systems.
  • Prodiving access to relevant datasets: We're currently collectig relevant datasets for carbon-aware test cases such as solar production or carbon intensity traces to simplify the setup of test cases.
  • Integrating the SAM: NREL's System Advisor Model (SAM) will soon be available as a subsystem in Vessim.

Publications

If you use Vessim in your research, please cite our vision paper:

@misc{wiesner2023vessim,
    title={A Testbed for Carbon-Aware Applications and Systems}, 
    author={Wiesner, Philipp and Behnke, Ilja and Kao, Odej},
    year={2023},
    eprint={2306.09774},
    archivePrefix={arXiv},
    primaryClass={cs.DC}
}

Or our journal paper on software-in-the-loop similation for carbon-aware applications:

@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}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vessim-0.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

vessim-0-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file vessim-0.tar.gz.

File metadata

  • Download URL: vessim-0.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for vessim-0.tar.gz
Algorithm Hash digest
SHA256 ff244c138f2e1953125afc0e17faf0b9f65f2831d59fda577e686703964c44b9
MD5 842fd623309fbeeedfb928cf9270894a
BLAKE2b-256 256211438b4a7f73c2590429103dba444b0f0d6bd9da1eedeac67e6df599d04f

See more details on using hashes here.

File details

Details for the file vessim-0-py3-none-any.whl.

File metadata

  • Download URL: vessim-0-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for vessim-0-py3-none-any.whl
Algorithm Hash digest
SHA256 23addab003beb878a5f228bc0d595fbe3fbc2b2b555da01b8759c9b63c141cb6
MD5 406aeb636f70963b03c057b5ba5e6479
BLAKE2b-256 e35f4d1b923fe7fc7a183b577adea2dc4f0c79ef83dfc00b53a402870b738e71

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page