Feature modelblocks (#16)

* Move to modelblocks
* Use PU instead of CF for naming

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: irm-codebase

.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: i.ruizmanuel@tudelft.nl
 author_family_name: Ruiz Manuel
 author_given_name: Ivan
-github_org: calliope-project
+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: clio - Hydropower module
+    around the globe, based on Euro-Calliope methods.
+module_long_name: Modelblocks - Hydropower module
 module_short_name: module_hydropower

.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

@@ -6,4 +6,4 @@ on:
 
 jobs:
   copier-update:
-    uses: calliope-project/data-module-template/.github/workflows/template-check-version.yml@latest
+    uses: modelblocks-org/data-module-template/.github/workflows/template-check-version.yml@latest

.github/workflows/pr-ci.yml

@@ -1,11 +1,43 @@
-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@feature-ci-cdsapi
-    secrets:
+  build:
+    name: Build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      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
+      - 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/results/integration_test/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

.pre-commit-config.yaml

@@ -12,6 +12,7 @@ repos:
       # Repo quality
       - id: check-added-large-files
         args: [--enforce-all --maxkb=600]
+        exclude: ^pixi\.lock$
       - id: forbid-submodules
       - id: check-case-conflict
       - id: check-illegal-windows-names
@@ -32,7 +33,7 @@ repos:
 
   # Snakemake file formatting
   - repo: https://github.com/snakemake/snakefmt
-    rev: v0.11.0
+    rev: v0.11.4
     hooks:
       - id: snakefmt
 
@@ -44,4 +45,4 @@ repos:
         files: .*\.(py|smk|md)$|^Snakefile$
 
 ci:  # https://pre-commit.ci/
-  autoupdate_schedule: monthly
+  autoupdate_schedule: quarterly

AUTHORS

@@ -2,6 +2,6 @@ This is the list of contributors for copyright purposes.
 
 This does not necessarily list everyone who has contributed to this software's
 code or documentation. For a full contributor list, see:
-<https://github.com/calliope-project/module_hydropower/graphs/contributors>
+<https://github.com/modelblocks-org/module_hydropower/graphs/contributors>
 
 Ivan Ruiz Manuel, <i.ruizmanuel@tudelft.nl>

CITATION.cff

@@ -3,8 +3,8 @@
 # https://citation-file-format.github.io/
 cff-version: 1.2.0
 message: If you use this software or data produced by it, please cite it using the metadata from this file.
-title: "clio - module_hydropower: clio - Hydropower module"
-repository: "https://github.com/calliope-project/module_hydropower"
+title: "Modelblocks - module_hydropower: Hydropower module"
+repository: "https://github.com/modelblocks-org/module_hydropower"
 license: Apache-2.0
 authors:
   - given-names: Ivan