open-mastr 0.17.0

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

open-mastr

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

License
Documentation
Tests
Publication
Data Publication
Development
Community

• Introduction

• Benefits provided by open-mastr

• Documentation

• Installation

  • PyPI

  • GitHub

• Examples of Usage

• External Resources

• Collaboration

• License and Citation

  • Software

  • Data

Introduction

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.

Benefits provided by open-mastr

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!

Documentation

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.

Installation

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.

PyPI

Install the current release of open-mastr with pip:

pip install open-mastr

GitHub

For development, clone this repository manually.

git clone [e-mail]: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]"

Examples of Usage

These projects already use open-mastr:

• PV- und Windflächenrechner

• Wasserstoffatlas

• EE-Status App

• Digiplan Anhalt

• EmPowerPlan

• Goal100 Monitor

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

External Resources

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

• The bundesAPI/Marktstammdaten-API is another implementation to access data via an official API.

Collaboration

Everyone is invited to develop this repository with good intentions.

Please follow the workflow described in the CONTRIBUTING.md.

License and Citation

Software

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.

Copyright: open-MaStR © Reiner Lemoine Institut © fortiss © OFFIS | AGPL-3.0-or-later

Data

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