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

Add OFFIS as partner to README #493

Merged
merged 12 commits into from
Sep 17, 2024
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/

## [v0.XX.X] unreleased - 2024-XX-XX
### Added
- Add OFFIS eV as partner organization [#493](https://github.com/OpenEnergyPlatform/open-MaStR/pull/493)
### Changed
- Fix usercff workflow [#545](https://github.com/OpenEnergyPlatform/open-MaStR/issues/544)
- Fix docs on user-defined output path for csv, xml, database
Expand Down
12 changes: 8 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

.. image:: https://user-images.githubusercontent.com/14353512/199113556-4b53660f-c628-4138-8d01-3719595ecda1.png
.. image:: docs/images/README_HeaderThreePartners.svg
:align: left
:target: https://github.com/OpenEnergyPlatform/open-MaStR
:alt: MaStR logo
Expand Down Expand Up @@ -59,8 +59,6 @@ Documentation
| Find the `documentation <https://open-mastr.readthedocs.io/en/latest/>`_ hosted on ReadTheDocs.

| The original API documentation can be found on the `Webhilfe des Marktstammdatenregisters <https://www.marktstammdatenregister.de/MaStRHilfe/subpages/webdienst.html>`_.
| If you are interested in browsing the MaStR online, check out the privately hosted `Marktstammdatenregister.dev <https://marktstammdatenregister.dev/>`_.
| Also see the `bundesAPI/Marktstammdaten-API <https://github.com/bundesAPI/marktstammdaten-api>`_ for another implementation.
FlorianK13 marked this conversation as resolved.
Show resolved Hide resolved


Installation
Expand Down Expand Up @@ -112,7 +110,13 @@ changes in a `Pull Request <https://github.com/OpenEnergyPlatform/open-MaStR/pul
- `Wasserstoffatlas <https://wasserstoffatlas.de/>`_
- `EE-Status App <https://ee-status.de/>`_
- `Digiplan Anhalt <https://digiplan.rl-institut.de/>`_
- `Data Quality Assessment of the MaStR <https://marktstammdaten.kotthoff.dev/>`_

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 <https://github.com/marktstammdatenregister-dev>`_.
- The `bundesAPI/Marktstammdaten-API <https://github.com/bundesAPI/marktstammdaten-api>`_ is another implementation to access data via an official API.

Collaboration
=============
Expand All @@ -129,7 +133,7 @@ Software
| This repository is licensed under the **GNU Affero General Public License v3.0 or later** (AGPL-3.0-or-later).
| See `LICENSE.md <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/LICENSE.md>`_ for rights and obligations.
| See the *Cite this repository* function or `CITATION.cff <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/CITATION.cff>`_ for citation of this repository.
| Copyright: `open-MaStR <https://github.com/OpenEnergyPlatform/open-MaStR/>`_ © `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ © `fortiss <https://www.fortiss.org/>`_ | `AGPL-3.0-or-later <https://www.gnu.org/licenses/agpl-3.0.txt>`_
| Copyright: `open-MaStR <https://github.com/OpenEnergyPlatform/open-MaStR/>`_ © `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ © `fortiss <https://www.fortiss.org/>`_ © `OFFIS <https://www.offis.de/>`_ | `AGPL-3.0-or-later <https://www.gnu.org/licenses/agpl-3.0.txt>`_

Data
----
Expand Down
127 changes: 127 additions & 0 deletions docs/images/README_HeaderThreePartners.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ site_dir: _build


copyright: |
&copy; 2023 <a href="https://reiner-lemoine-institut.de/" target="_blank" rel="noopener">RLI</a> and <a href="https://fortiss.org" target="_blank" rel="noopener">fortiss GmbH</a>
&copy; <a href="https://reiner-lemoine-institut.de/" target="_blank" rel="noopener">RLI</a> and <a href="https://fortiss.org" target="_blank" rel="noopener">fortiss GmbH</a> and <a href="https://www.offis.de/" target="_blank" rel="noopener">OFFIS e.V.</a>