Skip to content

Commit

Permalink
Document dataset MatrData
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasJeckstadt committed Aug 10, 2023
1 parent 405695b commit dc144f3
Showing 1 changed file with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions src/egon/data/datasets/mastr.py
Original file line number Diff line number Diff line change
@@ -1,22 +1,6 @@
"""
Download Marktstammdatenregister (MaStR) datasets unit registry.
It incorporates two different datasets:
Dump 2021-05-03
* Source: https://sandbox.zenodo.org/record/808086
* Used technologies: PV plants, wind turbines, biomass, hydro plants,
combustion, nuclear, gsgk, storage
* Data is further processed in dataset
:py:class:`egon.data.datasets.power_plants.PowerPlants`
Dump 2022-11-17
* Source: https://sandbox.zenodo.org/record/1132839
* Used technologies: PV plants, wind turbines, biomass, hydro plants
* Data is further processed in module
:py:mod:`egon.data.datasets.power_plants.mastr` `PowerPlants`
Todo: Finish docstring
TBD
"""

from dataclasses import dataclass
Expand All @@ -32,7 +16,7 @@


def download_mastr_data():
"""Download MaStR data from Zenodo"""
"""Download MaStR data from Zenodo."""

def download(dataset_name, download_dir):
print(f"Downloading dataset {dataset_name} to {download_dir} ...")
Expand Down Expand Up @@ -68,6 +52,32 @@ def download(dataset_name, download_dir):

@dataclass
class mastr_data_setup(Dataset):
"""
Download Marktstammdatenregister (MaStR) datasets unit registry.
The downloaded data incorporates two different datasets:
Dump 2021-05-03
* Source: https://sandbox.zenodo.org/record/808086
* Used technologies: PV plants, wind turbines, biomass, hydro plants, combustion,
nuclear, gsgk, storage
* Data is further processed in dataset :py:class:`PowerPlants
<egon.data.datasets.power_plants.PowerPlants>`
Dump 2022-11-17
* Source: https://sandbox.zenodo.org/record/1132839
* Used technologies: PV plants, wind turbines, biomass, hydro plants
* Data is further processed in module :py:mod:`mastr
<egon.data.datasets.power_plants.mastr>` and :py:class:`PowerPlants
<egon.data.datasets.power_plants.PowerPlants>`
*Dependencies*
* :py:func:`Setup <egon.data.datasets.database.setup>`
*Resulting Tables*
* :py:class:`PowerPlants <egon.data.datasets.power_plants.PowerPlants>`
"""

#:
name: str = "MastrData"
#:
Expand Down

0 comments on commit dc144f3

Please sign in to comment.