merge README.md, CITATION.md, repo config, gh workflows, pre-commit etc.

Author: lkstrp

.git-blame-ignore-revs

@@ -8,6 +8,8 @@
 
 # Custom commits
 9865a970893d9e515786f33c629b14f71645bf1e
+# DE model specific
+ca1f43c23f1c0936cb9f9e1062854fdf0060c409
 
 # pre-commit commits
 4a1933f49aaf2ed530d13100efbd34b8f32e103e

.github/pull_request_template.md

@@ -1,14 +1,8 @@
-Closes # (if applicable).
-
-## Changes proposed in this Pull Request
-
-
-## Checklist
-
-- [ ] I tested my contribution locally and it works as intended.
-- [ ] Code and workflow changes are sufficiently documented.
-- [ ] Changed dependencies are added to `envs/environment.yaml`.
-- [ ] Changes in configuration options are added in `config/config.default.yaml`.
-- [ ] Changes in configuration options are documented in `doc/configtables/*.csv`.
-- [ ] Sources of newly added data are documented in `doc/data_sources.rst`.
-- [ ] A release note `doc/release_notes.rst` is added.
+Before asking for a review for this PR make sure to complete the following checklist:
+
+- [ ] Workflow with target rule `ariadne_all` completes without errors
+- [ ] The logic of `export_ariadne_variables` has been adapted to the changes
+- [ ] One or several figures that validate the changes in the PR have been posted as a comment
+- [ ] A brief description of the changes has been added to `Changelog.md`
+- [ ] The latest `main` has been merged into the PR
+- [ ] The config has a new prefix of the format `YYYYMMDDdescriptive_title`

.github/workflows/validate.yaml

@@ -16,11 +16,13 @@ jobs:
     if: github.event.pull_request.head.repo.full_name == github.repository
     runs-on: self-hosted
     steps:
-    - uses: lkstrp/[email protected].2
+    - uses: lkstrp/[email protected].4
       with:
         step: run-self-hosted-validation
-        env_file: envs/environment.yaml
-        snakemake_config: config/test/config.validator.yaml
+        env_file: environment.yaml
+        snakemake_config: config/config.yaml
+        pre_command: "build_scenarios -f"
+        main_command: "ariadne_all"
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -30,20 +32,20 @@ jobs:
     needs: run-validation
     runs-on: ubuntu-latest
     steps:
-    - uses: lkstrp/[email protected].2
+    - uses: lkstrp/[email protected].4
       with:
         step: create-comment
-        snakemake_config: config/test/config.validator.yaml
+        snakemake_config: config/config.yaml
         # The path starting from prefix in config
         # For plot results/<prefix>/<scenario>/<plot_name>.png pass
         # <scenario>/<plot_name>.png
         plots: >
           "
-          graphs/energy.svg
-          graphs/costs.svg
-          graphs/balances-energy.svg
-          graphs/balances-urban_central_heat.svg
-          graphs/balances-urban_decentral_heat.svg
-          graphs/balances-rural_heat.svg
+          KN2045_Bal_v4/ariadne/primary_energy.png
+          KN2045_Bal_v4/ariadne/secondary_energy.png
+          KN2045_Bal_v4/ariadne/final_energy.png
+          ariadne_comparison/Trade-Secondary-Energy-Hydrogen-Volume.png
+          ariadne_comparison/Trade-Secondary-Energy-Liquids-Hydrogen-Volume.png
+          ariadne_comparison/Capacity-Electricity-Solar.png
           "
         validator_key: ${{ secrets.VALIDATOR_KEY }}

.gitignore

@@ -75,3 +75,10 @@ d1gam3xoknrgr2.cloudfront.net/
 merger-todos.md
 
 *.html
+
+# DE model specific
+cidportal.jrc.ec.europa.eu
+zenodo.org
+globalenergymonitor.org/wp-content/uploads/2023/07/Europe-Gas-Tracker-2023-03-v3.xlsx
+fnb-gas.de
+raw.githubusercontent.com

.pre-commit-config.yaml

@@ -1,6 +1,3 @@
-# SPDX-FileCopyrightText: : 2022 The PyPSA-Eur Authors
-#
-# SPDX-License-Identifier: CC0-1.0
 exclude: "^LICENSES"
 
 repos:
@@ -86,9 +83,3 @@ repos:
   hooks:
   - id: jupyter-notebook-cleanup
     exclude: examples/solve-on-remote.ipynb
-
-  # Check for FSFE REUSE compliance (licensing)
-- repo: https://github.com/fsfe/reuse-tool
-  rev: v4.0.3
-  hooks:
-  - id: reuse

.reuse/dep5

@@ -1,52 +1,12 @@
-# SPDX-FileCopyrightText: : 2021 The PyPSA-Eur Authors
-#
-# SPDX-License-Identifier: CC0-1.0
-
-cff-version: 1.1.0
-message: "If you use this package, please cite it in the following way."
-title: "PyPSA-Eur: An open sector-coupled optimisation model of the European energy system"
-repository: https://github.com/pypsa/pypsa-eur
-version: 0.13.0
+cff-version: 1.2.0
+message: "pypsa-de"
+title: "Kopernikus-Projekt Ariadne - Gesamtsystemmodell PyPSA-Eur"
+repository: https://github.com/PyPSA/pypsa-de
+version: 0.0.0
+doi: "N/A"
+date-released: "N/A"
 license: MIT
 authors:
-  - family-names: Brown
-    given-names: Tom
-    orcid: https://orcid.org/0000-0001-5898-1911
-  - family-names: Victoria
-    given-names: Marta
-    orcid: https://orcid.org/0000-0003-1665-1281
-  - family-names: Zeyen
-    given-names: Elisabeth
-    orcid: https://orcid.org/0000-0002-7262-3296
-  - family-names: Hofmann
-    given-names: Fabian
-    orcid: https://orcid.org/0000-0002-6604-5450
-  - family-names: Neumann
-    given-names: Fabian
-    orcid: https://orcid.org/0000-0001-8551-1480
-  - family-names: Frysztacki
-    given-names: Martha
-    orcid: https://orcid.org/0000-0002-0788-1328
-  - family-names: Hampp
-    given-names: Johannes
-    orcid: https://orcid.org/0000-0002-1776-116X
-  - family-names: Schlachtberger
-    given-names: David
-    orcid: https://orcid.org/0000-0002-8167-8213
-  - family-names: Hörsch
-    given-names: Jonas
-    orcid: https://orcid.org/0000-0001-9438-767X
-  - family-names: Schledorn
-    given-names: Amos
-  - family-names: Schauß
-    given-names: Caspar
-  - family-names: van Greevenbroek
-    given-names: Koen
-  - family-names: Millinger
-    given-names: Markus
-  - family-names: Glaum
-    given-names: Philipp
-  - family-names: Xiong
-    given-names: Bobby
-  - family-names: Seibold
-    given-names: Toni
+  - family-names: Your surname
+    given-names: Christoph Tries
+    orcid: https://orcid.org/0009-0000-2425-0993