Code Monkey home page Code Monkey logo

open-mastr's Introduction

Documentation Status CI OpenEnergyPlatform

open-mastr

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

  1. browsed 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 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.

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

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

License / Copyright

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.

open-MaStR © Reiner Lemoine Institut © fortiss | AGPL-3.0

open-mastr's People

Contributors

ludee avatar floriank13 avatar deniztepe avatar chrwm avatar bachibouzouk avatar gplssm avatar solar-c avatar coroa avatar oakca avatar christian-rli avatar izzet91 avatar stap-m avatar curiousleo avatar

Stargazers

Kristian Lande avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.