Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #460

Merged
merged 74 commits into from
Nov 20, 2023
Merged
Changes from 1 commit
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
a0d5358
Include pypistats link in Readme #434
FlorianK13 Jul 24, 2023
7ab90b7
Upgrade to python 3.10 #434
FlorianK13 Jul 28, 2023
f5b966e
Add mkdocs dependencies #434
FlorianK13 Jul 28, 2023
ca53a9c
Add linting config for ruff linter
FlorianK13 Jul 28, 2023
3105fd2
Initial commit for mkdocs documentation page #434
FlorianK13 Jul 28, 2023
1dd4959
Change docstrings to be .md conform #434
FlorianK13 Jul 28, 2023
aadc754
Add a watch for automatic docstring update #434
FlorianK13 Aug 7, 2023
892f2e6
Update docstrings to be mkdocs conform #434
FlorianK13 Aug 7, 2023
e077a35
Include links to other package functions #434
FlorianK13 Aug 7, 2023
7a8c7da
Add default options for mkdocstrings #434
FlorianK13 Aug 7, 2023
98f2a18
Split references in advanced and basic #434
FlorianK13 Aug 7, 2023
ab2062e
Update README.rst
chrwm Aug 7, 2023
cf82453
Integrate toc into navigation #434
chrwm Aug 7, 2023
b43f030
Initial dataset description #434
FlorianK13 Aug 9, 2023
0075ef7
Update the naviation #434
FlorianK13 Aug 9, 2023
fd5b250
Extend starting page #434
FlorianK13 Aug 9, 2023
f983f21
Make MaStRAPI docstring markdown conform #434
FlorianK13 Aug 9, 2023
63b8b27
Make MaStRDownload docstrings mkdocs conform #434
FlorianK13 Aug 9, 2023
685685b
Clarify content of subchapter #434
FlorianK13 Aug 9, 2023
a9db5a1
Add configuration chapter #434
FlorianK13 Aug 9, 2023
7a353ab
Delete unnecessary handler #434
FlorianK13 Aug 9, 2023
3bd4595
Make MaStRMirror docstrings markdown conform #434
FlorianK13 Aug 10, 2023
b5fc4e4
Add advanced documentation pages #434
FlorianK13 Aug 10, 2023
1b7727a
Use RLI super repo theme #434
FlorianK13 Aug 10, 2023
a0d05fb
Add data model picture in english #434
FlorianK13 Aug 10, 2023
b9cf0f1
Update Zenodo link #434
chrwm Aug 10, 2023
480f842
Adjust/add sections #434
chrwm Aug 14, 2023
438772e
Add css-based TOC blur/highlighting #434
chrwm Aug 14, 2023
2897b29
Separate data and software publication #434
chrwm Aug 14, 2023
bd2d634
Add logo and favicon #434
chrwm Aug 14, 2023
0accee6
Add markdown extension to enable the usage of content tabs #434
Aug 15, 2023
ce32b87
Create welcome file for Advanced tab #434
Aug 15, 2023
ecff56d
Add welcome file into the Advanced tab #434
Aug 15, 2023
d7bdb9d
Move bulk trade-offs into admonition #434
chrwm Aug 16, 2023
29c02c6
Update zenodo link in README #434
FlorianK13 Aug 16, 2023
e948edf
Add contributions section #434
chrwm Aug 17, 2023
090d4aa
Add db background info in Q&A style #434
chrwm Aug 17, 2023
8e6cc94
Change to grey favicon #434
FlorianK13 Aug 17, 2023
fe5d58a
Add automated release notes from github #458
FlorianK13 Aug 17, 2023
30841fd
Define docs build dependencies #434
FlorianK13 Aug 17, 2023
da413d0
Switch dependencies from sphinx to mkdocs #434
FlorianK13 Aug 17, 2023
c6239e6
Change readthedocs to use mkdocs #434
FlorianK13 Aug 21, 2023
bb2d470
Repair link to file #434
FlorianK13 Aug 21, 2023
fe8bb7e
Delete unused mkdocstring option #434
FlorianK13 Aug 21, 2023
ef69002
Repair cross-ref links #434
FlorianK13 Aug 21, 2023
6180b0e
Merge branch 'develop' into feature-434-documentation
FlorianK13 Aug 21, 2023
a8e0a6e
Add total number of Downloads #434
FlorianK13 Aug 23, 2023
4553090
Make advance welcome screen empty
chrwm Aug 29, 2023
883fe17
Add mike #434
chrwm Aug 29, 2023
8f0efaa
Add mike to dev requierements #434
chrwm Aug 29, 2023
5f43c27
Delete outdated tables.xml info #434
chrwm Aug 29, 2023
d1c9d09
Update configuration.md #434
chrwm Aug 29, 2023
5298db0
Update configuration.md #434
chrwm Aug 29, 2023
cb20d2c
Put all advanced doc in advanced.md #434
FlorianK13 Aug 30, 2023
e136e87
Repair headings in advanced #434
FlorianK13 Aug 30, 2023
e7154ee
Add mermaid diagram of bulk download process #434
FlorianK13 Aug 30, 2023
44aee50
Add DB Browser screenshot #434
FlorianK13 Aug 30, 2023
0ac99e6
Put data tables in tabs #434
FlorianK13 Aug 30, 2023
ed5c396
Merge contribution table into text #434
chrwm Sep 25, 2023
25d5712
Add high level MaStRAPI description #434
chrwm Sep 25, 2023
7193e22
Add high level MastrDownload description #434
chrwm Sep 26, 2023
9ec0a0b
Add high level MaStRMirror description #434
chrwm Sep 26, 2023
8ebeb2a
Add first part of high level csv description #434
chrwm Sep 26, 2023
425083f
Update project directory #434
chrwm Sep 26, 2023
31881bc
Merge branch 'develop' into feature-434-documentation
FlorianK13 Sep 27, 2023
559066d
Uncomment create_additional_data_requests
FlorianK13 Sep 27, 2023
7101a12
Delete unused rst files #434
FlorianK13 Sep 27, 2023
5526613
Repair reference links #434
FlorianK13 Sep 27, 2023
eb8cda0
Run spell and grammar checker #434
FlorianK13 Sep 27, 2023
6e560aa
Merge develop into documentation branch #434
FlorianK13 Nov 3, 2023
29a661d
Update Readme Documentation section #434
FlorianK13 Nov 3, 2023
a13f12f
Formulate API usage more precisely #434
FlorianK13 Nov 3, 2023
2ad18cf
Delete ruff.toml #434
FlorianK13 Nov 20, 2023
f92da11
Update changelog #434
FlorianK13 Nov 20, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add first part of high level csv description #434
  • Loading branch information
chrwm committed Sep 26, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 8ebeb2a319c6ea6037640524b2ae2691a74a6e54
22 changes: 9 additions & 13 deletions docs/dataset.md
Original file line number Diff line number Diff line change
@@ -23,11 +23,6 @@ As you might have noticed, we distinguish between `bulk` and `API` datasets. Wit
The structure of the database is historically determined by the data retrieved via API. (open-mastr existed before the XML-dump was provided).
<br> See [MaStR data model](#Mastr-data-model)

??? question "Why does the XML table structure and some column headers are different to the data retrieved via API requests?"

The difference in structure might stem from zipping the data to XML. <br> The reason for difference in column
header naming is unknown to us. However, open-mastr maps XML-dump columns to API columns.


## Tables in the database

@@ -36,14 +31,6 @@ As you might have noticed, we distinguish between `bulk` and `API` datasets. Wit

After downloading the MaStR, you will find a database with a large number of tables. Here we give a brief overview of what you can find in those tables:

??? question "How are the database tables created from the XML files?"

#FIXME: link to bulk reference

??? question "How are the csv files created from the database tables?"

FIXME: how to link to Reference section?

### Tables in the local database


@@ -101,3 +88,12 @@ A useful overview of the MaStR data model can be found [here (in german)](https:

=== "original image (german)"
![Data model of the MaStR](images/DetailAnlagenModellMaStR.png)


## Tables as CSV

Tables from the database can be exported to csv files. By default, all available power plant unit data will be exported
to csv files.

For exported csv's additional available data is joined on basic unit data. For example: For biomass power plants one csv
is exported consisting of the join of four database tables (unit data, chp data, permit data, eeg data).