Initial module

.copier-answers.yml

@@ -0,0 +1,13 @@
+# Changes here will be overwritten by Copier
+# !!!!! DO NOT MANUALLY MODIFY THIS FILE !!!!!
+_commit: latest
+_src_path: https://github.com/modelblocks-org/data-module-template.git
+author_email: j.a.c.launer@tudelft.nl
+author_family_name: Launer
+author_given_name: Jann
+github_org: modelblocks-org
+license: Apache-2.0
+module_description: This module prepares electricity demand timeseries for Europe
+    at arbitrary resolution
+module_long_name: Data module for electricity demand in Europe
+module_short_name: module_demand_electricity

.editorconfig

@@ -0,0 +1,22 @@
+# Documentation: https://EditorConfig.org
+# Inspired by Django .editorconfig file
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.{yaml,yml,.cff}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = true
+indent_size = 4
+
+[*.{diff,patch}]
+trim_trailing_whitespace = false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+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):**
+ - OS: [e.g. Linux Fedora 43, Windows 11...]
+ - Version [e.g. v0.1.1]
+
+**Additional context**
+Add any other context about the problem here.

.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/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,18 @@
+Fixes #
+
+## Summary of changes in this pull request
+
+*
+*
+*
+
+## Reviewer checklist
+
+* [ ] 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

@@ -0,0 +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:
+    permissions:
+      contents: read
+      issues: write
+    uses: modelblocks-org/data-module-template/.github/workflows/template-check-version.yml@latest

.github/workflows/pr-ci.yml

@@ -0,0 +1,43 @@
+# !!!!! 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:
+  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
+        env: # Set the secret as an environment variable
+          TOKEN_ENTSOE: ${{ secrets.TOKEN_ENTSOE }}
+        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

@@ -0,0 +1,11 @@
+name: Release
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  release-workflow:
+    permissions:
+      contents: write
+    uses: modelblocks-org/data-module-template/.github/workflows/template-release.yml@latest

.gitignore

@@ -0,0 +1,29 @@
+### OS-specific
+.DS_Store
+
+### Editors
+*~
+\#*\#
+**/.vscode
+.$*
+
+### Byte-compiled files
+__pycache__
+*.pyc
+
+### Environments
+.pixi/
+
+### Snakemake
+.snakemake/
+gurobi.log
+
+### Notebooks
+.ipynb_checkpoints
+
+# Ignore mutable folders
+**/logs/*
+**/resources/*
+**/results/*
+**/temp/*
+**/tmp/*

.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+default_language_version:
+  python: python3
+
+repos:
+  # Generic 'file quality' testing
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # Machine-friendliness
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      # 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
+      - id: check-merge-conflict
+      - id: debug-statements
+      # Detect config. file issues
+      - id: check-json
+      - id: check-yaml
+        args: [--unsafe]
+
+  # Python file formatting
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  # Snakemake file formatting
+  - repo: https://github.com/snakemake/snakefmt
+    rev: v1.0.0
+    hooks:
+      - id: snakefmt
+
+  # Spelling
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        files: .*\.(py|smk|md)$|^Snakefile$
+
+ci:  # https://pre-commit.ci/
+  autoupdate_schedule: quarterly

.snakemake-workflow-catalog.yml

@@ -0,0 +1,5 @@
+# Integration with https://snakemake.github.io/snakemake-workflow-catalog/#
+usage:
+  software-stack-deployment:
+    conda: true
+  report: false

AUTHORS

@@ -0,0 +1,7 @@
+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_demand_electricity/graphs/contributors>
+
+Jann Launer, <j.a.c.launer@tudelft.nl>

CITATION.cff

@@ -0,0 +1,11 @@
+# Citation file
+# For more information, see:
+# 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: "Modelblocks - module_demand_electricity: Data module for electricity demand in Europe"
+repository: "https://github.com/modelblocks-org/module_demand_electricity"
+license: Apache 2.0
+authors:
+  - given-names: Jann
+    family-names: Launer

INTERFACE.yaml

@@ -0,0 +1,29 @@
+# Module Input-Output structure for automated doc. generation
+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:
+    token_entsoe:
+      default: "<resources>/user/token_entsoe.txt"
+      description: "User token for ENTSO-E API access."
+    shapes:
+      default: "<resources>/user/{shape}/shapes.parquet"
+      description: >
+        Shapes to aggregate the output data to.
+        IMPORTANT: they must add up to the full spatial extent of the country.
+        The module's processing requires it.
+  results:
+    demand_electricity_MW:
+      default: "<results>/{shape}/demand_electricity_MW.parquet"
+      description: Electricity demand profile per custom shape in units of MW.
+wildcards:
+  shape: Name of the custom shape is a wildcard to allow multiple outputs based on different shapes.