ProFSea v3

.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "profsea-v3"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    groups:
+      actions-updates:
+        patterns:
+          - "*"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    target-branch: "profsea-v3"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"

.github/workflows/deploy-docs.yml

@@ -0,0 +1,68 @@
+# (C) Crown Copyright 2025, Met Office.
+# The LICENSE file contains full licensing details.
+name: Documentation
+
+on:
+  # Runs on pushes targeting the default branch.
+  push:
+    branches: ["profsea-v3"]
+
+  # Allows you to run this workflow manually from the Actions tab.
+  workflow_dispatch:
+
+# Use a login shell so the Conda environment is activated.
+defaults:
+  run:
+    shell: bash -leo pipefail {0}
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages.
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment,
+# skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs
+# as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup GitHub Pages
+        uses: actions/configure-pages@v6
+
+      - uses: mamba-org/setup-micromamba@v3
+        with:
+          environment-file: docs-environment.yml
+          environment-name: profsea-climate-docs
+          cache-environment: true
+          cache-environment-key: env-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('docs-environment.yml') }}
+
+      - name: Build with Sphinx
+        run:  make --directory=docs html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/build/html
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pytest.yml

@@ -0,0 +1,38 @@
+name: Pytest Suite
+
+on:
+  push:
+    branches:
+      - 'profsea-v3'
+
+  pull_request:
+    branches:
+      - profsea-v3
+
+jobs:
+  test:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      # 1. Grab the repository code
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      # 2. Set up the Python environment
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12" # Adjust this to match your project's target version
+          cache: 'pip'           # Speeds up subsequent runs
+
+      # 3. Install the package and test dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]"
+
+      # 4. Execute the test suite
+      - name: Run Pytest
+        run: |
+          pytest tests/ -v

.github/workflows/ruff.yml

@@ -0,0 +1,35 @@
+name: Ruff Linting
+
+on:
+  push:
+    branches:
+      - 'profsea-v3'
+  pull_request:
+    branches:
+      - profsea-v3
+
+jobs:
+  ruff:
+    name: Code Quality (Ruff)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          cache: 'pip'
+
+      - name: Install Ruff
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run Ruff Linter
+        run: ruff check --output-format=github .
+
+      - name: Run Ruff Formatter
+        run: ruff format --check .

.gitignore

@@ -1,4 +1,12 @@
 # Folders
 *__pycache__*
 profsea.egg-info
+data/
+.pytest_cache/
+.ipynb_checkpoints/
+.ruff_cache/
+profsea/profsea-assets/
 
+# Ignore the documentation build directory
+docs/build
+*.DS_Store

README.md

@@ -1,15 +1,35 @@
-# ProFSea-tool
+# ProFSea <img width="100" alt="logo" src="https://github.com/user-attachments/assets/cba78630-9965-4b66-8be1-065ae975229e" />
 
-[![DOI](https://zenodo.org/badge/713453340.svg)](https://zenodo.org/doi/10.5281/zenodo.10255467)
+[![DOI](https://zenodo.org/badge/713453340.svg)](https://zenodo.org/doi/10.5281/zenodo.10255467) [![tests](https://img.shields.io/github/actions/workflow/status/MetOffice/ProFSea-tool/pytest.yml?branch=profsea-v3&label=Tests&logo=github&logoColor=white)](https://github.com/MetOffice/ProFSea-tool/actions/workflows/pytest.yml) [![lint](https://img.shields.io/github/actions/workflow/status/MetOffice/ProFSea-tool/ruff.yml?branch=profsea-v3&label=Linting)](https://github.com/MetOffice/ProFSea-tool/actions/workflows/ruff.yml) [![docs](https://img.shields.io/github/actions/workflow/status/MetOffice/ProFSea-tool/deploy-docs.yml?branch=profsea-v3&label=Documentation)](https://github.com/MetOffice/ProFSea-tool/actions/workflows/deploy-docs.yml) [![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&label=Code%20style)](https://github.com/astral-sh/ruff)
 
-The ProFSea tool should be cited as: Perks, R., & Weeks, J. (2023). MetOffice/ProFSea-tool: v1.0.0 (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.10255468
+ProFSea is sea-level rise simulator based on statistical emulations of physical modelling experiments and lines of evidence from the IPCC and across the literature. It's modular, easy to setup and self-contained - all you need is global mean surface temperature and ocean heat content forcing anomalies, using any baseline period, and you're good to go.
 
-## User Guide
-A user guide summarising the underpinning science on sea-level projections and providing guidance on how to set-up and run the Met Office Projecting Future Sea Level (ProFSea) tool can be found here: [10.5281/zenodo.10134070](https://zenodo.org/doi/10.5281/zenodo.10134070).
+We simulate sea-level change contributions from:
 
-Users are advised to read this guide before using any products as it describes the data availability, the main outputs from the tool and the caveats and limitations.
+- Antartic Ice Sheet 🇦🇶
+- Greenland Ice Sheet 🧊
+- Glacier melt 🏔️
+- Thermal expansion 🌡️
+- Landwater ⛰️
 
-The ProFSea tool user guide should be cited as: Perks, R. J. (2023). Met Office Projecting Future Sea Level (ProFSea) tool - User Guide (1.1). Met Office. https://doi.org/10.5281/zenodo.10245409
+ProFSea can calculate projections of both global mean sea-level rise and spatially-resolved sea-level change fields:
+
+<p align="center">
+  <img width="480" height="273" alt="output" src="https://github.com/user-attachments/assets/82122190-1566-4386-b558-da32b4bee7e7" />
+</p>
+
+All the data required to run the regionalisation module can be found here: [![DOI](https://doi.org/badge/10.5281/20427061.svg)](https://doi.org/10.5281/zenodo.20427061)
+
+## Developments
+
+Ongoing developments include:
+
+- [x] 🛠️ Full spatial field projections of regional sea-level change
+- [x] 🛠️ Use any input climate forcing to produce ProFSea projections
+- [x] 🛠️ Updates to sea-level components based on the latest evidence in the literature
+- [ ] 🛠️ Observational constraints to projection ensembles
+- [x] 🛠️ Structural enhancements such as updated workflows, GitHub Actions and general reformatting
+- [x] 🛠️ Full code documentation
 
 ## Contributors
 Several people have contributed to the development of the ProFSea tool and User Guide documentation, namely: Rachel Perks, Jacob Cheung, Benjamin Harrison, Katie Hodge, Mathew Palmer, Michael Sanderson, Hamish Steptoe, Jennifer Weeks and Gregory Munday.

docs-environment.yml

@@ -0,0 +1,9 @@
+name: profsea-sphinx-docs
+
+dependencies:
+  - pre-commit
+  - pydata-sphinx-theme
+  - sphinx
+  - sphinx-design
+  - nbsphinx
+  - pandoc

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)