Pre-release

This release is a pre-release and may not be stable for production use.

MVS - Multi-Vector Simulator of the E-Land toolbox

Rights: Reiner Lemoine Institut (Berlin)

The multi-vector simulator (MVS) allows the evaluation of local sector-coupled energy systems that include the energy carriers electricity, heat and/or gas. The MVS has three main features:

Analysis of an energy system model, which can be defined from csv or json files, including its costs and performance parameters.
Near-future investments into power generation and storage assets can be optimized aiming at least-cost supply of electricity and heat.
Future energy supply scenarios that integrate emerging technologies helping to meet sustainability goals and decrease adverse climate effects can be evaluated, e.g. through high renewable energy shares or sector-coupling technologies.

The tool is being developed within the scope of the H2020 project E-LAND (Integrated multi-vector management system for Energy isLANDs, project homepage HERE). A graphical user interface for the MVS will be integrated.

Latest release Check the latest release. Please check the CHANGELOG.md for past updates and changes.

Disclaimer As the MVS is still under development, changes might still occur in the code as well as code structure. If you want to try the MVS, please make sure to check this project regularly.

For advanced programmers: You can also use the dev branch that includes the latest updates and changes. You find the changelog HERE.

Getting started

If you are interested to try out the code, please feel free to do so! In case that you are planning to use it for a specific or a larger-scale project, we would be very happy if you would get in contact with us, eg. via issue. Maybe you have ideas that can help the MVS move forward? Maybe you noticed a bug that we can resolve?

We are still working on including a readthedocs for the MVS. Some information on this tool and code is already available here (stable version, latest developments here).

Setup and installation

To set up the MVS, follow the steps below:

If python3 is not pre-installed: Install miniconda (for python 3.7: https://docs.conda.io/en/latest/miniconda.html)
Clone or download the latest MVS release

git clone https://github.com/rl-institut/multi-vector-simulator.git

and move to the multi-vector-simulator folder
Download the cbc-solver into your system from https://ampl.com/dl/open/cbc/ and integrate it in your system, ie. unzip, place into chosen path, add path to your system variables (Windows: “System Properties” -->”Advanced”--> “Environment Variables”, requires admin-rights).

You can also follow the steps from the oemof setup instructions
Open Anaconda prompt (or other software as Pycharm) to create and activate a virtual environment

conda create -n [your_env_name] python=3.6 activate [your env_name]
Install required packages from requirements.txt file using pip

pip install -r requirements/default.txt

Test if that the cbc solver is properly installed by typing

oemof_installation_test

You should at least get a confirmation that the cbc solver is working

*****************************
Solver installed with oemof:

cbc: working
glpk: not working
gurobi: not working
cplex: not working

*****************************
oemof successfully installed.
*****************************

Install the multi-vector-simulator package locally

python setup.py install
Test if the MVS is running by executing

python mvs_tool.py -i tests/inputs
You can also run all existing tests by executing

pip install -r requirements/test.txt

pytest tests/

Using the MVS

To run the MVS with custom inputs you have several options:

0) Use the default settings

If you create a folder named inputs at the root of the repository (you can use the folder input_template for inspiration) it will be taken as default input folder and you can simply run

`python mvs_tool.py`

A default output folder will be created, if you run the same simulation several time you would have to either overwrite the existing output file with

`python mvs_tool.py -f`

Or provide another output folder's path

python mvs_tool.py -o <path_to_other_output_folder>

1) Use the command line

Edit the json input file (or csv files) and run

python mvs_tool.py -i path_input_folder -ext json -o path_output_folder

With path_input_folder: path to folder with input data,

ext: json for using a json file and csv for using csv files

and path_output_folder: path of the folder where simulation results should be stored.

For more information about the possible command lines

python mvs_tool.py -h

2) Use the `main()` function

Edit the csv files (or, for devs, the json file) and run the main() function. The following kwargs are possible:

overwrite (bool): Determines whether to replace existing results in path_output_folder with the results of the current simulation (True) or not (False). Default: False.
input_type (str): Defines whether the input is taken from the mvs_config.json file ("json") or from csv files ('csv') located within <path_input_folder>/csv_elements/. Default: json.
path_input_folder (str): The path to the directory where the input CSVs/JSON files are located. Default: inputs/.
path_output_folder (str): The path to the directory where the results of the simulation such as the plots, time series, results JSON files are saved by MVS E-Lands. Default: MVS_outputs/.
display_output (str): Sets the level of displayed logging messages. Options: "debug", "info", "warning", "error". Default: "info".
lp_file_output (bool): Specifies whether linear equation system generated is saved as lp file. Default: False.

Generate pdf report

directly after running a simulation

Use the option -pdf in the command line python mvs_tool.py to generate a pdf report in the simulation's output folder (default in MVS_outputs/simulation_report.pdf):

python mvs_tool.py -pdf

post-processing

To generate a report of the simulation's results, run the following command after a simulation generated an output folder:

python mvs_report.py

the report should appear in your browser (at http://127.0.0.1:8050) as an interactive Plotly Dash app.

You can then print the report via your browser print functionality (ctrl+p), however the layout of the pdf report is only well optimized for chrome or chromimum browser.

It is also possible to automatically save the report as pdf by using the option -pdf. By default , it will save the report in the report folder. Seepython mvs_report.py -h for more information about possible options. The css and images used to make the report pretty should be located under report/assets.

Contributing

If you want to contribute to this project, please read CONTRIBUTING.md. For less experienced github users we propose a workflow HERE.

Release files for multi-vector-simulator 0.5.0rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for multi-vector-simulator 0.5.0rc1
File	Size	Uploaded
multi_vector_simulator-0.5.0rc1.tar.gz	93.6 kB	Oct 8, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for multi-vector-simulator 0.5.0rc1
File	Interpreter	ABI	Platform	Reset
multi_vector_simulator-0.5.0rc1-py3-none-any.whl 107.5 kB Oct 8, 2020	Python 3	none	any	Details

Total release size: 201.1 kB

Release files / multi_vector_simulator-0.5.0rc1.tar.gz

Download URL	multi_vector_simulator-0.5.0rc1.tar.gz
Size	93.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`1e14ae80bd2c470ef3f0895d3ab930ac617a47e69d97891a46f9314fba91a83f`
BLAKE2b-256 checksum How to use checksums	`d636ee93d4ecfbca67e4ea0089cd6d23583a36eb3bc60d32ef9a9e149208730b`
Upload date	Oct 8, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.9`

Release files / multi_vector_simulator-0.5.0rc1-py3-none-any.whl

Download URL	multi_vector_simulator-0.5.0rc1-py3-none-any.whl
Size	107.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`eaf86c974d561c633f8e737dc34f88ff88ccb35ef9bd2a8348e08a1c1a6403f6`
BLAKE2b-256 checksum How to use checksums	`fd6efb0cbd20cf745077c380626ad3df4b319e0a1f601c20b1bc131702c74c92`
Upload date	Oct 8, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.9`