Merge pull request #12 from ISI-MIP/isimip_utils

Refactor and use isimip-utils

Author: jochenklar

.github/workflows/ci.yaml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - main
+    - test
+    tags:
+    - "*"
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  actions: read
+
+env:
+  PYTHONDONTWRITEBYTECODE: 1
+  FORCE_COLOR: 1
+  PYTHON_VERSION: "3.12"
+
+jobs:
+  build:
+    name: Build distribution 👷
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repo 🛎️
+      uses: actions/checkout@v6
+      with:
+        persist-credentials: false
+
+    - name: Set up Python 🐍
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+        cache: pip
+
+    - name: Install build 🧱
+      run: python3 -m pip install build --user
+
+    - name: Build a binary wheel and a source tarball 🛠️
+      run: python3 -m build
+
+    - name: Store the distribution packages 📤
+      uses: actions/upload-artifact@v5
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  pypi:
+    name: Publish distribution to PyPI 📦
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/isimip-ea
+
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download the distribution packages 📥
+      uses: actions/download-artifact@v6
+      with:
+        name: python-package-distributions
+        path: dist/
+
+    - name: Publish to PyPI 🚀
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/ci.yml

@@ -7,17 +7,15 @@ __pycache__/
 *.save
 .DS_Store
 
+/env
+/venv
+
 /build
 /dist
 /*.egg-info
+
 /.pytest_cache
 /.ruff_cache
+
 /.coverage*
 /htmlcov
-/env
-/.env
-*.sh
-
-testing/tmp
-
-.ipynb_checkpoints

.gitignore

@@ -3,16 +3,21 @@ repos:
     hooks:
       - id: check-hooks-apply
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v6.0.0
     hooks:
       - id: check-ast
+      - id: check-yaml
       - id: end-of-file-fixer
-        exclude: \.json$
       - id: trailing-whitespace
-        exclude: fldmean\.csv$
       - id: debug-statements
+
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.284
+    rev: v0.14.6
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.39.2
+    hooks:
+    - id: typos

.pre-commit-config.yaml

@@ -1,18 +1,19 @@
 cff-version: 1.2.0
-title: ISIMIP quality assessment
-message: >-
-  If you use this software, please cite it using the
-  metadata from this file.
-type: software
+message: If you use this software in your research, please cite it using the provided Digital Object Identifier (DOI).
+
+title: ISIMIP extraction and analysis
+abstract: A command line tool for extraction and analysis of datasets within the ISIMIP project.
+
 authors:
   - family-names: Klar
     given-names: Jochen
     orcid: 'https://orcid.org/0000-0002-5883-4273'
   - family-names: Büchner
     given-names: Matthias
     orcid: 'https://orcid.org/0000-0002-1382-7424'
-  - family-names: Mengel
-    given-names: Matthias
-    orcid: 'https://orcid.org/0000-0001-6724-9685'
-repository-code: 'https://github.com/ISI-MIP/isimip-qc'
+  - family-names: Inga
+    given-names: Sauer
+    orcid: https://orcid.org/0000-0002-9302-2131
+
 license: MIT
+repository-code: 'https://github.com/ISI-MIP/isimip-qc'

CITATION.cff

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Inter-Sectoral Impact Model Intercomparison Project
+Copyright (c) 2022-2026 Potsdam Institute for Climate Impact Research
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal