open-MaStR

Download and process German energy data from BNetzA database Marktstammdatenregister.
https://github.com/openenergyplatform/open-mastr

Category: Energy Systems
Sub Category: Energy Data Accessibility and Integration

Keywords

dataset datasets energy energy-data marktstammdatenregister oep open-energy-family python solar

Keywords from Contributors

energy-system ontology oemof sql-alchemy-bindings photovoltaic grids feature-toggle feature-flag featured training

Last synced: about 17 hours ago
JSON representation

Repository metadata

A collaborative software to download the energy database Marktstammdatenregister (MaStR)

• Host: GitHub
• URL: https://github.com/openenergyplatform/open-mastr
• Owner: OpenEnergyPlatform
• License: agpl-3.0
• Created: 2019-08-21T14:11:11.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2025-04-19T20:46:05.000Z (7 days ago)
• Last Synced: 2025-04-22T06:56:06.954Z (5 days ago)
• Topics: dataset, datasets, energy, energy-data, marktstammdatenregister, oep, open-energy-family, python, solar
• Language: Python
• Homepage: https://open-mastr.readthedocs.io/en/latest/
• Size: 31.5 MB
• Stars: 100
• Watchers: 7
• Forks: 23
• Open Issues: 33
• Releases: 18
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Citation: CITATION.cff

README.rst

          
.. image:: https://raw.githubusercontent.com/OpenEnergyPlatform/open-MaStR/refs/heads/production/docs/images/README_HeaderThreePartners.svg
    :align: left
    :target: https://github.com/OpenEnergyPlatform/open-MaStR
    :alt: MaStR logo

==========
open-mastr
==========

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

.. list-table::
   :widths: 10, 50

   * - License
     - |badge_license|
   * - Documentation
     - |badge_rtd|
   * - Tests
     - |badge_ci|
   * - Publication
     - |badge_pypi| |badge_joss|
   * - Data Publication
     - |badge_zenodo|
   * - Development
     - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
   * - Community
     - |badge_contributing| |badge_contributors| |badge_repo_counts| |PyPI download month| |Total PyPI downloads|
   

.. contents::
    :depth: 2
    :local:
    :backlinks: top

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
 
#. browsed and filtered `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 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 `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``:

.. code-block:: python

    pip install open-mastr

GitHub
------

For development, clone this repository manually.

.. code-block:: python

    git clone [email protected]:OpenEnergyPlatform/open-MaStR.git
    cd open-MaStR

Setup the conda environment with

.. code-block:: python

    conda env create -f environment.yml

Install the package with

.. code-block:: python

    pip install "open_mastr[dev]"


Examples of Usage
==================
If you want to see your project in this list, write an  
`Issue `_ or add
changes in a `Pull Request `_.

- `PV- und Windflächenrechner `_
- `Wasserstoffatlas `_
- `EE-Status App `_
- `Digiplan Anhalt `_
- `Data Quality Assessment of the MaStR `_

External Resources
===================
Besides open-mastr, some other resources exist that ease the process of working with the Marktstammdatenregister:
- If you are interested in browsing the MaStR online, check out the github organisation `Marktstammdatenregister.dev `_.
- 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 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 `_


.. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/open-MaStR
    :target: LICENSE.txt
    :alt: License

.. |badge_rtd| image:: https://readthedocs.org/projects/open-mastr/badge/?style=flat
    :target: https://open-mastr.readthedocs.io/en/latest/
    :alt: Read the Docs

.. |badge_ci| image:: https://github.com/OpenEnergyPlatform/open-MaStR/actions/workflows/ci-production.yml/badge.svg
    :target: https://github.com/OpenEnergyPlatform/open-MaStR/actions?query=workflow%3ACI
    :alt: GitHub Actions

.. |badge_pypi| image:: https://img.shields.io/pypi/v/open-mastr.svg
    :target: https://pypi.org/project/open-mastr/
    :alt: PyPI

.. |badge_zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6807426.svg
    :target: https://doi.org/10.5281/zenodo.6807425
    :alt: zenodo

.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/open-MaStR
    :alt: open issues

.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/open-MaStR
    :alt: closes issues

.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/open-MaStR
    :alt: closes issues

.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/open-MaStR
    :alt: closes issues

.. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
    :alt: contributions

.. |badge_contributors| image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
    :alt: contributors

.. |badge_repo_counts| image:: https://hits.dwyl.com/OpenEnergyPlatform/open-MaStR.svg
    :alt: counter
    
.. |PyPI download month| image:: https://img.shields.io/pypi/dm/open-mastr?label=PyPi%20Downloads
    :target: https://pypistats.org/packages/open-mastr

.. |Total PyPI downloads| image:: https://static.pepy.tech/badge/open-mastr
    :target: https://pepy.tech/project/open-mastr

.. |badge_joss| image:: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e/status.svg
    :target: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e



        

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
authors:
  - family-names: "Hülk"
    given-names: "Ludwig"
    alias: "@Ludee"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0003-4655-2321"
  - family-names: "Pleßmann"
    given-names: "Guido"
    alias: "@gplssm"
    affiliation: "Reiner Lemoine Institut"
  - family-names: "Muschner"
    given-names: "Christoph"
    alias: "@chrwm"
    affiliation: "Reiner Lemoine Institut"
    orcid: " https://orcid.org/0000-0001-8144-5260"
  - family-names: "Kotthoff"
    given-names: "Florian"
    alias: "@FlorianK13"
    affiliation: "fortiss"
    orcid: " https://orcid.org/0000-0003-3666-6122"
  - family-names: "Tepe"
    given-names: "Deniz"
    alias: "@deniztepe"
    affiliation: "fortiss"
    orcid: " https://orcid.org/0000-0002-7605-0173"
  - family-names: "Amme"
    given-names: "Jonathan"
    alias: "@nesnoj"
    affiliation: "Reiner Lemoine Institut"
    orcid: " https://orcid.org/0000-0002-8563-5261"
  - family-names: "Imbrisca"
    given-names: "Alexandra-Andreea"
    alias: "@AlexandraImbrisca"
    affiliation: "Technical University of Munich"
title: "open-MaStR"
type: software
license: AGPL-3.0
version: 0.15.0
doi: 
date-released: 2025-04-19
url: "https://github.com/OpenEnergyPlatform/open-MaStR/"

---

Owner metadata

• Name: Open Energy Family
• Login: OpenEnergyPlatform
• Email:
• Kind: organization
• Description: The Open Energy Family and Open Energy Platform
• Website: https://github.com/OpenEnergyPlatform/organisation/blob/master/README.md
• Location: Magdeburg, Germany
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/37101913?v=4
• Repositories: 25
• Last ynced at: 2024-04-16T23:20:58.483Z
• Profile URL: https://github.com/OpenEnergyPlatform

---

GitHub Events

Total

• Create event: 15
• Release event: 1
• Issues event: 49
• Watch event: 13
• Delete event: 13
• Issue comment event: 149
• Push event: 50
• Pull request review comment event: 12
• Pull request event: 28
• Pull request review event: 45
• Fork event: 4

Last Year

• Create event: 15
• Release event: 1
• Issues event: 49
• Watch event: 13
• Delete event: 13
• Issue comment event: 149
• Push event: 50
• Pull request review comment event: 12
• Pull request event: 28
• Pull request review event: 45
• Fork event: 4

---

Committers metadata

Last synced: 7 days ago

Name	Email	Commits
Florian Kotthoff	f****f@p****e	576
Guido Pleßmann	g****n@r****e	417
Ludee	L****k@r****e	327
chrwm	c****r@r****e	242
Deniz Tepe	d****2@g****m	135
Bachibouzouk	p****c@r****e	67
nesnoj	j****e@r****e	66
solar-c		49
AlexandraImbrisca	a****6@g****m	45
solar-c	s****c	16
jadeaffenjaeger	e****r@r****e	14
Bachibouzouk	p****c@r****e	12
Benjamin W. Portner	b****r@b****t	10
Jonas Hoersch	j****s@c****t	7
Grazvy	k****s@f****g	7
Grazvy	7****y	6
oakca	o****a@g****m	5
Johann150	j****e@p****m	3
Christian Hofmann	c****n@r****e	3
Oskar.Oetken	o****n@r****e	3
Kevin Krämer	k****r@p****g	2
solar-c		2
Guido Pleßmann	R****n@p****l	2
Florian Maurer	m****r@f****e	2
izzet kilicarslan	i****n@r****e	2
stap-m	3****m	2
wok77	9****7	2
Guido Pleßmann	R****n@s****l	1
Leonhard Markert	c****o	1
steull	s****u@g****m	1

Committer domains:

• rl-institut.de: 9
• fh-aachen.de: 1
• projecttogether.org: 1
• fortiss.org: 1
• chaoflow.net: 1
• bauhaus-luftfahrt.net: 1
• rl-institute.de: 1
• posteo.de: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/openenergyplatform/open-mastr

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 1,785 last-month
• Total dependent packages: 0 (may contain duplicates)
• Total dependent repositories: 0 (may contain duplicates)
• Total versions: 61
• Total maintainers: 1

---

Dependencies

Score: 15.779280271320353