Module setup

.copier-answers.yml

@@ -1,13 +1,13 @@
 # Changes here will be overwritten by Copier
-# DO NOT MANUALLY MODIFY THIS FILE
+# !!!!! DO NOT MANUALLY MODIFY THIS FILE !!!!!
 _commit: latest
 _src_path: https://github.com/calliope-project/data-module-template.git
 author_email: j.a.c.launer@tudelft.nl
 author_family_name: Launer
 author_given_name: Jann
-github_org: calliope-project
-license: MIT
-module_description: This data module produces area potentials and capacity factors
-    for PV and wind at arbitrary spatial resolution.
-module_long_name: 'PV and wind area potentials and capacity factors '
+github_org: modelblocks-org
+license: Apache-2.0
+module_description: This data module produces capacity factors for PV and wind at
+    arbitrary spatial resolution.
+module_long_name: PV and wind capacity factors
 module_short_name: module_pv_wind

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,7 +24,7 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. Linux Fedora 41, Windows 10...]
+ - OS: [e.g. Linux Fedora 43, Windows 11...]
  - Version [e.g. v0.1.1]
 
 **Additional context**

.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: General information
+    url: https://www.modelblocks.org/
+    about: Please consult our website for general information on the Modelblocks methodology.

.github/pull_request_template.md

@@ -8,6 +8,11 @@ Fixes #
 
 ## Reviewer checklist
 
-* [ ] `INTERFACE.yaml` is up-to-date with all relevant user resources and results.
-* [ ] The integration example is up-to-date with a minimal use-case of the module.
-* [ ] Module documentation is up-to-date.
+* [ ] There are no `pip` dependencies in the module's environment files (`workflow/envs/`).
+* [ ] All rules use `pathvars` (e.g., `<results>`) in their inputs and outputs.
+* [ ] The integration test-suite is successful, including:
+    * [ ] `pre-commit.ci` tests pass.
+    * [ ] tests pass for all relevant OS configurations (linux, osx, windows).
+* [ ] Module documentation is up-to-date, including:
+    * [ ] `INTERFACE.yaml` mentions all relevant `pathvars` and `wildcards`.
+    * [ ] `README.md` describes how to use the module and has the necessary citations.

.github/workflows/check-version.yml

@@ -1,9 +1,13 @@
 # Check for changes in the upstream template. If changes are found, an issue is created
 name: Template check.
 on:
+  workflow_dispatch:
   schedule:
     - cron: '0 0 1 * *' # Runs at 00:00 UTC on the 1st day of every month
 
 jobs:
   copier-update:
-    uses: calliope-project/data-module-template/.github/workflows/template-check-version.yml@latest
+    permissions:
+      contents: read
+      issues: write
+    uses: modelblocks-org/data-module-template/.github/workflows/template-check-version.yml@latest

.github/workflows/pr-ci.yml

@@ -1,9 +1,41 @@
-name: CI
+# !!!!! DO NOT MODIFY UNLESS ABSOLUTELY NECESSARY !!!!!
+# This workflow helps standardise integration tests across data modules
+name: Pull Request CI tests for Modelblocks data modules
 on:
   pull_request:
     branches:
       - "main"
-
 jobs:
-  ci-tests:
-    uses: calliope-project/data-module-template/.github/workflows/template-pr-ci.yml@latest
+  build:
+    name: Build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup pixi
+        uses: prefix-dev/setup-pixi@v0.8.3
+      - name: Run integration tests
+        id: tests
+        run: pixi run test-integration
+        continue-on-error: true
+      - name: Run snakemake linting
+        id: linting
+        run: |
+          pixi run snakemake --lint --snakefile workflow/Snakefile
+          pixi run snakemake --lint --snakefile tests/integration/Snakefile
+        continue-on-error: true
+      - name: Save integration logs
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration-test-logs-${{ matrix.os }}
+          path: tests/integration/resources/module/logs
+          if-no-files-found: ignore
+          retention-days: 30
+      - name: Fail if integration or linting failed
+        if: ${{ steps.tests.outcome == 'failure' || steps.linting.outcome == 'failure' }}
+        run: exit 1

.github/workflows/release.yml

@@ -6,4 +6,6 @@ on:
 
 jobs:
   release-workflow:
-    uses: calliope-project/data-module-template/.github/workflows/template-release.yml@latest
+    permissions:
+      contents: write
+    uses: modelblocks-org/data-module-template/.github/workflows/template-release.yml@latest

.gitignore

@@ -11,6 +11,9 @@
 __pycache__
 *.pyc
 
+### Environments
+.pixi/
+
 ### Snakemake
 .snakemake/
 gurobi.log

.pre-commit-config.yaml

@@ -12,6 +12,7 @@ repos:
       # Repo quality
       - id: check-added-large-files
         args: [--enforce-all]
+        exclude: ^pixi\.lock$
       - id: forbid-submodules
       - id: check-case-conflict
       - id: check-illegal-windows-names
@@ -44,4 +45,4 @@ repos:
         files: .*\.(py|smk|md)$|^Snakefile$
 
 ci:  # https://pre-commit.ci/
-  autoupdate_schedule: monthly
+  autoupdate_schedule: quarterly

INTERFACE.yaml

@@ -1,20 +1,37 @@
 # Module Input-Output structure for automated doc. generation
-resources:
-  user:
-    user_message.md: "Example file emulating external files requested from a user."
-  automatic:
-    dummy_readme.md: "Example file emulating downloads determined by internal settings."
-results:
-  combined_text.md: "Example file emulating module results."
-
-# Wildcard example:
-# resources:
-#   user:
-#     shapes_{resolution}.geojson: region geometries.
-#   automatic:
-#     technology_data.parquet: dataset with technology characteristics.
-# results:
-#   '{resolution}/tech_capacity.parquet': description of output data.
-#   '{resolution}/results_image.png': description of output image.
-# wildcards:
-#   resolution: description of the wildcard’s purpose.
+pathvars:
+  snakemake_defaults:
+    logs:
+      default: "<logs>"
+      description: location of rule log files.
+    resources:
+      default: "<resources>"
+      description: "location of module resource files."
+    results:
+      default: "<results>"
+      description: "location of module results."
+  user_resources:
+    cutout:
+      default: "<resources>/user/cutout_{name_cutout}.nc"
+      description: "Cutout of meteorological data provided by user."
+    tech_specs:
+      default: "<resources>/user/tech_specs/{name_tech}.yaml"
+      description: "Technology specification of PV/wind."
+    layout_raster:
+      default: "<resources>/user/layout/{name_layout}.tif"
+      description: "Raster layout file describing the spatial distribution of capacity."
+    layout_point:
+      default: "<resources>/user/layout/{name_layout}.parquet"
+      description: "Point layout file describing the spatial distribution of capacity."
+    shapes:
+      default: "<resources>/user/shapes/{shape}.parquet"
+      description: "Geometries of shapes (e.g., administrative regions)."
+  results:
+    capacity_factors:
+      default: "<results>/{name_cutout}/{shape}/{name_layout}/capacityfactors_{name_tech}.nc"
+      description: Capacity factors for the specified technology.
+wildcards:
+  name_cutout: Cutout name
+  name_tech: Technology name
+  name_layout: Layout name
+  shape: Shape name