Skip to content

OpenEnergyPlatform/open-MaStR

Repository files navigation

MaStR logo

open-mastr

A package that provides an interface for downloading and processing the Marktstammdatenregister (MaStR)

License License
Documentation Read the Docs
Tests GitHub Actions
Publication PyPI badge_joss
Data Publication zenodo
Development open issues closes issues closes issues closes issues
Community contributions PyPI download month Total PyPI downloads

The python package open-mastr provides an interface for accessing the Marktstammdatenregister (MaStR) data. The MaStR is a German register provided by the German Federal Network Agency (Bundesnetzagentur / BNetza) that keeps track of all power and gas units located in Germany. It is a daily growing dataset with millions of data points covering electricity and gas production units, electricity and gas consumers, storages, grids, and energy market participants.

Generally, and besides the offerings of open-mastr, the MaStR data can be accessed via three main options:

  1. browse, filter and download in the browser
  2. download daily provided dumps
  3. access via the web service

These access options, however, are not exactly frictionless. open-mastr thus provides an interface for and improved developer experience of accessing the data. This project is intended for individuals who wish to "just work" with the MaStR data and who do not want to deal with the idiosyncrasies of the three access options above.

In particular, open-mastr facilitates access to the daily provided MaStR dumps with download methods (bulk) and by parsing the XML files to a relational database. Furthermore, the software provides a Python wrapper to access the MaStR SOAP web service (API).

Does open-mastr edit or change the MaStR data? No. open-mastr is a wrapper around the MaStR data and does not edit or change the data. It is intended to be used as a tool for working with the MaStR data.

Benefit Description
Data download and parsing Download, decode, and write data to a local database
Translation to English Translate table names and columns from German to English as well as an English documentation page of the dataset
Data processing Merge relevant information about different technologies to single csv files

Just here for the data? We regularly run the whole download and cleansing pipeline and upload the dataset as csv files at zenodo!

The documentation is in Material for Mkdocs markdown format in the doc sub-folder of the repository.
Find the documentation hosted on ReadTheDocs.
The original API documentation can be found on the Webhilfe des Marktstammdatenregisters.
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

For development, clone this repository manually.

git clone git@github.com:OpenEnergyPlatform/open-MaStR.git
cd open-MaStR

Setup the conda environment with

conda env create -f environment.yml

Install the package with

pip install "open_mastr[dev]"

These projects already use open-mastr:

If you want to see your project in this list, write an Issue or add changes in a Pull Request.

Besides open-mastr, some other resources exist that ease the process of working with the Marktstammdatenregister:

Everyone is invited to develop this repository with good intentions.
Please follow the workflow described in the CONTRIBUTING.md.
This repository is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).
See LICENSE.md for rights and obligations.
See the Cite this repository function or CITATION.cff for citation of this repository.
The original dataset is licensed under the Datenlizenz Deutschland – Namensnennung – Version 2.0 (DL-DE-BY-2.0)
Copyright: Marktstammdatenregister - © Bundesnetzagentur für Elektrizität, Gas, Telekommunikation, Post und Eisenbahnen | DL-DE-BY-2.0

About

A Python Package to Download and Process the German Power Plant and Energy System Registry Marktstammdatenregister (MaStR)

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors 21

Languages