Merge pull request #320 from PyPSA/pre-commit

Pre commit
PyPSA · Mar 6, 2023 · 5611817 · 5611817
2 parents 6d98edb + 604d086
commit 5611817
Show file tree

Hide file tree

Showing 59 changed files with 4,795 additions and 3,248 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1 @@
+13769f90af4500948b0376d57df4cceaa13e78b5
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -16,7 +16,7 @@ on:
     branches:
     - master
   schedule:
-    - cron: "0 5 * * TUE"
+  - cron: "0 5 * * TUE"
 
 env:
   CONDA_CACHE_NUMBER: 1 # Change this value to manually reset the environment cache
@@ -29,9 +29,9 @@ jobs:
       matrix:
         include:
           # Matrix required to handle caching with Mambaforge
-          - os: ubuntu-latest
-            label: ubuntu-latest
-            prefix: /usr/share/miniconda3/envs/pypsa-eur
+        - os: ubuntu-latest
+          label: ubuntu-latest
+          prefix: /usr/share/miniconda3/envs/pypsa-eur
 
           # - os: macos-latest
           #   label: macos-latest
@@ -44,63 +44,63 @@ jobs:
     name: ${{ matrix.label }}
 
     runs-on: ${{ matrix.os }}
-    
+
     defaults:
       run:
         shell: bash -l {0}
-        
+
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Clone pypsa-eur subworkflow
-        run: |
-          git clone https://github.com/pypsa/pypsa-eur ../pypsa-eur
-          cp ../pypsa-eur/test/config.test1.yaml ../pypsa-eur/config.yaml
-      
-      - name: Setup secrets
-        run: |
-          echo -ne "url: ${CDSAPI_URL}\nkey: ${CDSAPI_TOKEN}\n" > ~/.cdsapirc
-
-      - name: Add solver to environment
-        run: |
-          echo -e "- coincbc\n- ipopt<3.13.3" >> ../pypsa-eur/envs/environment.yaml
-
-      - name: Setup Mambaforge
-        uses: conda-incubator/setup-miniconda@v2
-        with:
-            miniforge-variant: Mambaforge
-            miniforge-version: latest
-            activate-environment: pypsa-eur
-            use-mamba: true
-            
-      - name: Set cache dates
-        run: |
-          echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
-          echo "WEEK=$(date +'%Y%U')" >> $GITHUB_ENV
-
-      - name: Cache data and cutouts folders
-        uses: actions/cache@v3
-        with:
-          path: |
-            data
-            ../pypsa-eur/cutouts
-            ../pypsa-eur/data
-          key: data-cutouts-${{ env.WEEK }}-${{ env.DATA_CACHE_NUMBER }}
-
-      - name: Create environment cache
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: ${{ matrix.prefix }}
-          key: ${{ matrix.label }}-conda-${{ env.DATE }}-${{ env.CONDA_CACHE_NUMBER }}
-
-      - name: Update environment due to outdated or unavailable cache
-        run: mamba env update -n pypsa-eur -f ../pypsa-eur/envs/environment.yaml
-        if: steps.cache.outputs.cache-hit != 'true'
-
-      - name: Test snakemake workflow
-        run: |
-          conda activate pypsa-eur
-          conda list
-          snakemake -call --configfile test/config.overnight.yaml
-          snakemake -call --configfile test/config.myopic.yaml
+    - uses: actions/checkout@v2
+
+    - name: Clone pypsa-eur subworkflow
+      run: |
+        git clone https://github.com/pypsa/pypsa-eur ../pypsa-eur
+        cp ../pypsa-eur/test/config.test1.yaml ../pypsa-eur/config.yaml
+
+    - name: Setup secrets
+      run: |
+        echo -ne "url: ${CDSAPI_URL}\nkey: ${CDSAPI_TOKEN}\n" > ~/.cdsapirc
+
+    - name: Add solver to environment
+      run: |
+        echo -e "- coincbc\n- ipopt<3.13.3" >> ../pypsa-eur/envs/environment.yaml
+
+    - name: Setup Mambaforge
+      uses: conda-incubator/setup-miniconda@v2
+      with:
+        miniforge-variant: Mambaforge
+        miniforge-version: latest
+        activate-environment: pypsa-eur
+        use-mamba: true
+
+    - name: Set cache dates
+      run: |
+        echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
+        echo "WEEK=$(date +'%Y%U')" >> $GITHUB_ENV
+
+    - name: Cache data and cutouts folders
+      uses: actions/cache@v3
+      with:
+        path: |
+          data
+          ../pypsa-eur/cutouts
+          ../pypsa-eur/data
+        key: data-cutouts-${{ env.WEEK }}-${{ env.DATA_CACHE_NUMBER }}
+
+    - name: Create environment cache
+      uses: actions/cache@v2
+      id: cache
+      with:
+        path: ${{ matrix.prefix }}
+        key: ${{ matrix.label }}-conda-${{ env.DATE }}-${{ env.CONDA_CACHE_NUMBER }}
+
+    - name: Update environment due to outdated or unavailable cache
+      run: mamba env update -n pypsa-eur -f ../pypsa-eur/envs/environment.yaml
+      if: steps.cache.outputs.cache-hit != 'true'
+
+    - name: Test snakemake workflow
+      run: |
+        conda activate pypsa-eur
+        conda list
+        snakemake -call --configfile test/config.overnight.yaml
+        snakemake -call --configfile test/config.myopic.yaml
diff --git a/.gitignore b/.gitignore
@@ -58,4 +58,4 @@ doc/_build
 
 *.ipynb
 
-data/costs_*
+data/costs_*
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,92 @@
+# SPDX-FileCopyrightText: : 2022 The PyPSA-Eur Authors
+#
+# SPDX-License-Identifier: CC0-1.0
+exclude: "^LICENSES"
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-merge-conflict
+  - id: end-of-file-fixer
+  - id: fix-encoding-pragma
+  - id: mixed-line-ending
+  - id: trailing-whitespace
+  - id: check-added-large-files
+    args: ["--maxkb=2000"]
+
+  # Sort package imports alphabetically
+- repo: https://github.com/PyCQA/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    args: ["--profile", "black", "--filter-files"]
+
+  # Convert relative imports to absolute imports
+- repo: https://github.com/MarcoGorelli/absolufy-imports
+  rev: v0.3.1
+  hooks:
+  - id: absolufy-imports
+
+  # Find common spelling mistakes in comments and docstrings
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.2
+  hooks:
+  - id: codespell
+    args: ['--ignore-regex="(\b[A-Z]+\b)"', '--ignore-words-list=fom,appartment,bage,ore,setis,tabacco'] # Ignore capital case words, e.g. country codes
+    types_or: [python, rst, markdown]
+    files: ^(scripts|doc)/
+
+  # Make docstrings PEP 257 compliant
+- repo: https://github.com/PyCQA/docformatter
+  rev: v1.5.1
+  hooks:
+  - id: docformatter
+    args: ["--in-place", "--make-summary-multi-line", "--pre-summary-newline"]
+
+- repo: https://github.com/keewis/blackdoc
+  rev: v0.3.8
+  hooks:
+  - id: blackdoc
+
+  # Formatting with "black" coding style
+- repo: https://github.com/psf/black
+  rev: 23.1.0
+  hooks:
+      # Format Python files
+  - id: black
+      # Format Jupyter Python notebooks
+  - id: black-jupyter
+
+  # Remove output from Jupyter notebooks
+- repo: https://github.com/aflc/pre-commit-jupyter
+  rev: v1.2.1
+  hooks:
+  - id: jupyter-notebook-cleanup
+    args: ["--remove-kernel-metadata"]
+
+  # Do YAML formatting (before the linter checks it for misses)
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.7.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, "2", --preserve-quotes]
+
+  # Format Snakemake rule / workflow files
+# - repo: https://github.com/snakemake/snakefmt
+#   rev: v0.8.1
+#   hooks:
+#   - id: snakefmt
+
+  # For cleaning jupyter notebooks
+- repo: https://github.com/aflc/pre-commit-jupyter
+  rev: v1.2.1
+  hooks:
+  - id: jupyter-notebook-cleanup
+    exclude: examples/solve-on-remote.ipynb
+
+  # Check for FSFE REUSE compliance (licensing)
+# - repo: https://github.com/fsfe/reuse-tool
+#   rev: v1.1.2
+#   hooks:
+#   - id: reuse
diff --git a/.syncignore-receive b/.syncignore-receive
@@ -11,4 +11,4 @@ __pycache__
 data
 notebooks
 benchmarks
-*.nc
+*.nc
diff --git a/.syncignore-send b/.syncignore-send
@@ -11,4 +11,4 @@ __pycache__
 notebooks
 benchmarks
 resources
-results
+results
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -17,4 +17,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.