The Marktstammdatenregister (MaStR) is a German register provided by the German Federal Network Agency (Bundesnetzagentur) that keeps track of all power and gas units located in Germany.
The MaStR data can be
- browsed online
- taken from daily provided dumps
- be accessed via the web service
The python package open-mastr
provides an interface for accessing the data.
It contains methods to download and parse the xml files (bulk) and the web service (API).
In this repository we are developing methods to analyze, validate and enrich the data. We want to collect and compile post processing scripts to improve data quality.
If you are interested in browsing the MaStR online, check out the privately hosted Marktstammdatenregister.dev.
Find the documentation hosted on ReadTheDocs.
It is recommended to use a virtual python environment, for example conda or virtualenv. The package is intended to be used with Python >=3.8
Install the current release of open-mastr
with pip
:
$ pip install open-mastr
To upgrade to a newer release use the --upgrade
flag:
$ pip install --upgrade open-mastr
Alternatively, you can manually download open-mastr
from
GitHub <https://github.com/OpenEnergyPlatform/open-MaStR>
_.
Change the CWD to the download folder open-MaStR/
.
git clone [email protected]:OpenEnergyPlatform/open-MaStR.git
cd open-MaStR
Optionally, a pre-defined conda environment can be used with
conda env create -f environment.yml
Install the package with
python setup.py install
This repository is licensed under GNU Affero General Public License v3.0 (AGPL-3.0).
See the LICENSE file for rights and limitations.
See the CITATION function if you want to mention this software in your publication.