Physrisk document drought

.github/CODEOWNERS

@@ -1 +1 @@
-*    @durandom @tumido
+*    @joemoorhouse

.github/dependabot.yml

@@ -0,0 +1,17 @@
+---
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # prettier-ignore
+  - package-ecosystem: "pip"  # See documentation for possible values
+    # prettier-ignore
+    directory: "/"  # Location of package manifests
+    commit-message:
+      prefix: "[dependabot] Chore:"
+    open-pull-requests-limit: 1
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  python-version: "3.8"
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: "Setup Python"
+      uses: actions/[email protected]
+      with:
+        python-version: ${{ env.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Run auto-tests
+      run: tox

.github/workflows/release.yml

@@ -0,0 +1,63 @@
+---
+name: "🐍📦 Production build and release"
+
+# GitHub/PyPI trusted publisher documentation:
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_dispatch:
+  push:
+    # Only invoked on release tag pushes
+    tags:
+      - v*.*.*
+
+env:
+  python-version: "3.8"
+
+jobs:
+  publish:
+    name: "🐍📦 Build and publish"
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      # IMPORTANT: mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup PDM for build commands"
+        uses: pdm-project/setup-pdm@v3
+        with:
+          version: 2.10.0
+
+      - name: "Setup Python"
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.python-version }}
+
+      - name: "Build with PDM backend"
+        run: |
+          pdm build
+
+      - name: "Sign packages with Sigstore"
+        uses: sigstore/[email protected]
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+
+      - name: "Remove files unsupported by PyPi"
+        run: |
+          if [ -f dist/buildvars.txt ]; then
+            rm dist/buildvars.txt
+          fi
+          rm dist/*.sigstore | true
+
+      - name: "Publish package to PyPI"
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test-release.yml

@@ -0,0 +1,69 @@
+---
+name: "🐍📦 Test build and publish to Test PyPI"
+
+# GitHub/PyPI trusted publisher documentation:
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+# yamllint disable-line rule:truthy
+on: push
+
+env:
+  python-version: "3.8"
+
+jobs:
+  publish:
+    name: "🐍📦 Test build and publish"
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+    permissions:
+      # IMPORTANT: mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup PDM for build commands"
+        uses: pdm-project/setup-pdm@v3
+        with:
+          version: 2.10.0
+
+      - name: "Setup Python"
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.python-version }}
+
+      - name: "Update version and output Run ID"
+        run: |
+          value=`scripts/version.sh`
+          scripts/dev-versioning.sh "$value-dev${{ github.run_id }}"
+          echo "$value-dev${{ github.run_id }}"
+          echo ${{ github.run_id }}
+
+      - name: "Output Run Number"
+        run: echo ${{ github.run_number }}
+
+      - name: "Build with PDM backend"
+        run: |
+          pdm build
+
+      - name: "Sign packages with Sigstore"
+        uses: sigstore/[email protected]
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+
+      - name: "Remove files unsupported by PyPi"
+        run: |
+          if [ -f dist/buildvars.txt ]; then
+            rm dist/buildvars.txt
+          fi
+          rm dist/*.sigstore | true
+
+      - name: Publish distribution to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

.gitignore

@@ -1,3 +1,6 @@
+# Credentials / Secrets
+credentials.env
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -57,7 +60,7 @@ docs/_build/
 target/
 
 # DotEnv configuration
-.env
+*.env
 
 # Database
 *.db
@@ -87,3 +90,9 @@ target/
 
 # Mypy cache
 .mypy_cache/
+
+# Virtual environment
+.venv/*
+src/test/data/coords.json
+credentials.env
+.pdm-python

.pre-commit-config.yaml

@@ -1,12 +1,7 @@
 ---
 repos:
-  - repo: git://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.1.10
-    hooks:
-      - id: remove-tabs
-
-  - repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: check-merge-conflict
@@ -16,51 +11,32 @@ repos:
       - id: check-case-conflict
       - id: check-docstring-first
       - id: check-json
+      - id: check-toml
+      - id: check-yaml
       - id: check-symlinks
       - id: detect-private-key
       - id: check-ast
       - id: debug-statements
 
-  - repo: git://github.com/pycqa/pydocstyle.git
-    rev: 6.1.1
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
     hooks:
-      - id: pydocstyle
-
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
-    hooks:
-      - id: check-toml
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.902
-    hooks:
-      - id: mypy
-        exclude: '^(docs|tasks|tests)|setup\.py'
-        args: [--ignore-missing-imports]
+      - id: remove-tabs
 
   - repo: https://github.com/psf/black
-    rev: 21.6b0
+    rev: '24.2.0'
     hooks:
       - id: black
-
-  - repo: https://github.com/tomcatling/black-nb
-    rev: '0.5.0'
-    hooks:
-      - id: black-nb
-
-  # Enable this in repositories with python packages.
-  # - repo: https://github.com/mgedmin/check-manifest
-  #   rev: '0.39'
-  #   hooks:
-  #     - id: check-manifest
+      - id: black-jupyter
 
   - repo: https://github.com/s-weigand/flake8-nb
-    rev: v0.3.0
+    rev: v0.5.3
     hooks:
       - id: flake8-nb
-        additional_dependencies: ['pep8-naming']
+        additional_dependencies:
+          - pep8-naming
         # Ignore all format-related checks as Black takes care of those.
-        args: ['--ignore', 'E2,W5', '--select', 'E,W,F,N', '--max-line-length=120']
+        args:
+          - --ignore=E2, W5, F401, E401, E704
+          - --select=E, W, F, N
+          - --max-line-length=120

.readthedocs.yaml

@@ -0,0 +1,28 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+   - pdf
+   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements-docs.txt