Skip to content

Commit 5a6d2fa

Browse files
sjpfenningersjpfenninger
committed
Initial commit
0 parents  commit 5a6d2fa

35 files changed

+857
-0
lines changed

‎.copier-answers.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changes here will be overwritten by Copier
2+
# DO NOT MANUALLY MODIFY THIS FILE
3+
_commit: latest
4+
_src_path: https://github.com/calliope-project/data-module-template
5+
author_email: s.pfenninger@tudelft.nl
6+
author_family_name: Pfenninger-Lee
7+
author_given_name: Stefan
8+
github_org: calliope-project
9+
license: Apache-2.0
10+
module_description: ''
11+
module_long_name: Area potentials
12+
module_short_name: module_area_potentials

‎.editorconfig‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Documentation: https://EditorConfig.org
2+
# Inspired by Django .editorconfig file
3+
4+
root = true
5+
6+
[*]
7+
indent_style = space
8+
indent_size = 4
9+
trim_trailing_whitespace = true
10+
end_of_line = lf
11+
insert_final_newline = true
12+
charset = utf-8
13+
14+
[*.{yaml,yml,.cff}]
15+
indent_size = 2
16+
17+
[*.md]
18+
trim_trailing_whitespace = true
19+
indent_size = 4
20+
21+
[*.{diff,patch}]
22+
trim_trailing_whitespace = false

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. Linux Fedora 41, Windows 10...]
28+
- Version [e.g. v0.1.1]
29+
30+
**Additional context**
31+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Fixes #
2+
3+
## Summary of changes in this pull request
4+
5+
*
6+
*
7+
*
8+
9+
## Reviewer checklist
10+
11+
* [ ] `INTERFACE.yaml` is up-to-date with all relevant user resources and results.
12+
* [ ] The integration example is up-to-date with a minimal use-case of the module.
13+
* [ ] Module documentation is up-to-date.

‎.github/workflows/check-version.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Check for changes in the upstream template. If changes are found, an issue is created
2+
name: Template check.
3+
on:
4+
schedule:
5+
- cron: '0 0 1 * *' # Runs at 00:00 UTC on the 1st day of every month
6+
7+
jobs:
8+
copier-update:
9+
uses: calliope-project/data-module-template/.github/workflows/template-check-version.yml@latest

‎.github/workflows/pr-ci.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: CI
2+
on:
3+
pull_request:
4+
branches:
5+
- "main"
6+
7+
jobs:
8+
ci-tests:
9+
uses: calliope-project/data-module-template/.github/workflows/template-pr-ci.yml@latest

‎.github/workflows/release.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: Release
2+
3+
on:
4+
release:
5+
types: [released]
6+
7+
jobs:
8+
release-workflow:
9+
uses: calliope-project/data-module-template/.github/workflows/template-release.yml@latest

‎.gitignore‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
### OS-specific
2+
.DS_Store
3+
4+
### Editors
5+
*~
6+
\#*\#
7+
**/.vscode
8+
.$*
9+
10+
### Byte-compiled files
11+
__pycache__
12+
*.pyc
13+
14+
### Snakemake
15+
.snakemake/
16+
gurobi.log
17+
18+
### Notebooks
19+
.ipynb_checkpoints
20+
21+
# Ignore mutable folders
22+
**/logs/*
23+
**/resources/*
24+
**/results/*
25+
**/temp/*
26+
**/tmp/*

‎.pre-commit-config.yaml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
default_language_version:
2+
python: python3
3+
4+
repos:
5+
# Generic 'file quality' testing
6+
- repo: https://github.com/pre-commit/pre-commit-hooks
7+
rev: v5.0.0
8+
hooks:
9+
# Machine-friendliness
10+
- id: trailing-whitespace
11+
- id: end-of-file-fixer
12+
# Repo quality
13+
- id: check-added-large-files
14+
args: [--enforce-all]
15+
- id: forbid-submodules
16+
- id: check-case-conflict
17+
- id: check-illegal-windows-names
18+
- id: check-merge-conflict
19+
- id: debug-statements
20+
# Detect config. file issues
21+
- id: check-json
22+
- id: check-yaml
23+
args: [--unsafe]
24+
25+
# Python file formatting
26+
- repo: https://github.com/astral-sh/ruff-pre-commit
27+
rev: v0.9.6
28+
hooks:
29+
- id: ruff
30+
args: [--fix, --exit-non-zero-on-fix]
31+
- id: ruff-format
32+
33+
# Snakemake file formatting
34+
- repo: https://github.com/snakemake/snakefmt
35+
rev: v0.10.2
36+
hooks:
37+
- id: snakefmt
38+
39+
# Spelling
40+
- repo: https://github.com/codespell-project/codespell
41+
rev: v2.4.1
42+
hooks:
43+
- id: codespell
44+
files: .*\.(py|smk|md)$|^Snakefile$
45+
46+
ci: # https://pre-commit.ci/
47+
autoupdate_schedule: monthly

0 commit comments

Comments
 (0)