Rework to comply with convention v1.0.0

.all-contributorsrc

@@ -0,0 +1,16 @@
+{
+  "projectName": "module_hydropower",
+  "projectOwner": "modelblocks-org",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "none",
+  "contributors": [],
+  "contributorsPerLine": 7,
+  "linkToUsage": false,
+  "contributorsSortAlphabetically": true
+}

.copier-answers.yml

@@ -1,6 +1,6 @@
 # Changes here will be overwritten by Copier
 # !!!!! DO NOT MANUALLY MODIFY THIS FILE !!!!!
-_commit: latest
+_commit: v1.0.2
 _src_path: https://github.com/calliope-project/data-module-template.git
 author_email: i.ruizmanuel@tudelft.nl
 author_family_name: Ruiz Manuel
@@ -9,5 +9,5 @@ github_org: modelblocks-org
 license: Apache-2.0
 module_description: A module to calculate hydropower inflow timeseries for facilities
     around the globe, based on Euro-Calliope methods.
-module_long_name: Modelblocks - Hydropower module
+module_long_name: Hydropower module
 module_short_name: module_hydropower

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,13 +8,13 @@ assignees: ''
 ---
 
 **Describe the bug**
-A clear and concise description of what the bug is.
+A clear and concise description of the bug.
 
-**To Reproduce**
+**Steps to reproduce**
 Steps to reproduce the behavior:
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
+2. Run '...'
+3. Provide '...'
 4. See error
 
 **Expected behavior**
@@ -23,9 +23,9 @@ A clear and concise description of what you expected to happen.
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
+**Environment (please complete the following information):**
  - OS: [e.g. Linux Fedora 43, Windows 11...]
- - Version [e.g. v0.1.1]
+ - Version: [e.g. v0.1.1]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Modelblocks project website
+    url: https://www.modelblocks.org/
+    about: Consult our website for general information on our initiative.
+  - name: Documentation
+    url: https://modelblocks.readthedocs.io/
+    about: Read our documentation for general questions and guidelines.
+  - name: Community chat
+    url: https://calliope-modelblocks.zulipchat.com
+    about: Reach out to our community on our official Zulip chat.

.github/workflows/check-version.yml

@@ -1,9 +1,75 @@
-# Check for changes in the upstream template. If changes are found, an issue is created
-name: Template check.
+# 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
 
+defaults:
+  run:
+    shell: bash --noprofile --norc -euo pipefail {0}
+
 jobs:
-  copier-update:
-    uses: modelblocks-org/data-module-template/.github/workflows/template-check-version.yml@latest
+  copier-check-update:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      issues: write
+    env:
+      ISSUE_TITLE: Template update available
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Check for template updates
+        id: copier_check_update
+        run: |
+          update_json="$(uvx --from 'copier>=9.15.2' copier check-update --output-format json)"
+          echo "$update_json"
+          {
+            echo "update_available=$(jq -r '.update_available // false' <<< "$update_json")"
+            echo "current_version=$(jq -r '.current_version // "unknown"' <<< "$update_json")"
+            echo "latest_version=$(jq -r '.latest_version // "unknown"' <<< "$update_json")"
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Check for existing update issue
+        if: steps.copier_check_update.outputs.update_available == 'true'
+        id: existing_issue
+        run: |
+          issue_count="$(gh issue list \
+            --repo "${{ github.repository }}" \
+            --state open \
+            --search "$ISSUE_TITLE in:title" \
+            --json title \
+            --jq "map(select(.title == \"$ISSUE_TITLE\")) | length")"
+          if [[ "$issue_count" -gt 0 ]]; then
+            echo "exists=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=false" >> "$GITHUB_OUTPUT"
+          fi
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Open update issue
+        if: steps.copier_check_update.outputs.update_available == 'true' && steps.existing_issue.outputs.exists != 'true'
+        run: |
+          gh issue create \
+            --repo "${{ github.repository }}" \
+            --title "$ISSUE_TITLE" \
+            --body "A new version of the Modelblocks data module template is available.
+
+          Current template version: ${{ steps.copier_check_update.outputs.current_version }}
+          Latest template version: ${{ steps.copier_check_update.outputs.latest_version }}
+
+          Please update this project using:
+
+          \`\`\`shell
+          copier update --skip-answered --defaults
+          \`\`\`
+
+          Review the resulting changes before merging them."
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr-ci.yml

@@ -13,13 +13,12 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.12"]
     env:
       CDSAPI_KEY: ${{ secrets.CDSAPI_KEY }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - name: Setup pixi
-        uses: prefix-dev/setup-pixi@v0.8.3
+        uses: prefix-dev/setup-pixi@v0.9.6
       - name: Run integration tests
         id: tests
         run: pixi run test-integration
@@ -32,10 +31,10 @@ jobs:
         continue-on-error: true
       - name: Save integration logs
         if: ${{ always() }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: integration-test-logs-${{ matrix.os }}
-          path: tests/integration/results/integration_test/logs
+          path: tests/integration/resources/module/logs
           if-no-files-found: ignore
           retention-days: 30
       - name: Fail if integration or linting failed

.gitignore

@@ -12,7 +12,8 @@ __pycache__
 *.pyc
 
 ### Environments
-.pixi/
+.pixi/*
+!.pixi/.gitignore
 
 ### Snakemake
 .snakemake/

.pixi/.gitignore

@@ -0,0 +1,3 @@
+*
+!.gitignore
+!config.toml

.pixi/config.toml

@@ -0,0 +1 @@
+pinning-strategy = "latest-up"

.pre-commit-config.yaml

@@ -11,7 +11,7 @@ repos:
       - id: end-of-file-fixer
       # Repo quality
       - id: check-added-large-files
-        args: [--enforce-all --maxkb=600]
+        args: [--enforce-all]
         exclude: ^pixi\.lock$
       - id: forbid-submodules
       - id: check-case-conflict
@@ -25,15 +25,15 @@ repos:
 
   # Python file formatting
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.9
+    rev: v0.15.18
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
 
   # Snakemake file formatting
   - repo: https://github.com/snakemake/snakefmt
-    rev: v1.0.0
+    rev: v2.0.2
     hooks:
       - id: snakefmt
 

INTERFACE.yaml

@@ -1,15 +1,17 @@
-# Module Input-Output structure for automated doc. generation
+# Module Input-Output structure for automated docs generation
+convention_version: v1.0.0
+
 pathvars:
   snakemake_defaults:
     logs:
       default: "<logs>"
-      description: location of rule log files.
+      description: location of snakemake log files.
     resources:
       default: "<resources>"
-      description: "location of module resource files."
+      description: "location of module resource (input) files."
     results:
       default: "<results>"
-      description: "location of module results."
+      description: "location of module result (output) files."
   user_resources:
     shapes:
       default: "<resources>/user/{shapes}/shapes.parquet"

README.md

@@ -1,4 +1,4 @@
-# Modelblocks - Hydropower module
+# Hydropower module
 
 A module to calculate hydropower inflow timeseries for facilities around the globe, based on Euro-Calliope methods.
 
@@ -78,6 +78,21 @@ cd module_hydropower
 pixi install --all
 ```
 
+Please be aware that this is a multi-environment project (see [pixi.toml](./pixi.toml) for details).
+- `default`: used for development and integration testing.
+Because it contains `Snakemake`, `conda` and `pytest` as dependencies it **should not be used** in `Snakemake` rules.
+- `module`: contains minimal dependencies used in `Snakemake` rules.
+If modified, be sure to export it to `Snakemake` so it can be recreated by module users:
+
+```shell
+# create module.yaml and conda-spec pin files in workflow/envs/
+pixi run export-snakemake-env module
+```
+
+
+## Testing
+<!-- Please do not modify this templated section -->
+
 For testing, simply run:
 
 ```shell
@@ -111,3 +126,16 @@ Tröndle, T., & Pickering, B. (2021). Euro-Calliope (Version 1.2.0.dev) [Compute
 
 Additionally, this module relies on the following for testing and stable integration:
 * **Data stability aid.** Ruiz Manuel, I., & Pfenninger, S. (2026). Modelblocks - module hydropower (v0.1.0) [Data set]. Zenodo. <https://doi.org/10.5281/zenodo.19401947>
+
+## Contributors ✨
+
+Thanks goes to these wonderful people, sorted alphabetically ([emoji key](https://allcontributors.org/en/reference/emoji-key/)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!