Skip to content

Latest commit

 

History

History
180 lines (121 loc) · 6.76 KB

README.rst

File metadata and controls

180 lines (121 loc) · 6.76 KB
Raw
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 zenodo
Development open issues closes issues closes issues closes issues
Community contributions contributors counter PyPI download month

Introduction

The Marktstammdatenregister (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.

The MaStR data can be

  1. browsed and filtered online
  2. taken from daily provided dumps
  3. 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 SOAP 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.

Documentation

The documentation is in sphinx reStructuredText 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.
If you are interested in browsing the MaStR online, check out the privately hosted Marktstammdatenregister.dev.
Also see the bundesAPI/Marktstammdaten-API for another implementation.

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

python setup.py install

Examples of Usage

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

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.

Data

The data has the license 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