Merge pull request #251 from Climate-REF/update-aft

lewisjared · web-flow · commit e84587252daf · 2025-04-16T07:19:21.000-06:00
diff --git a/NOTICE b/NOTICE
@@ -1,3 +1,3 @@
 CMIP Rapid Evaluation Framework
 
-Copyright 2024- AR7 Fast Track REF Technical Implementation Team
+Copyright 2024- CMIP7 Assessment Fast Track REF Technical Implementation Team
diff --git a/README.md b/README.md
@@ -14,12 +14,12 @@ REF is a community project, and we welcome contributions from anyone.
 ## Deployments
 
 The concept of the REF was proposed by the CMIP Model Benchmarking Task Team (MBTT),
-to enable the near-realtime evaluation of AR7 FastTrack datasets.
+to enable the near-realtime evaluation of CMIP7 Assessment Fast Track (AFT) datasets.
 This particular deployment will feature a set of metrics selected by
-the MBTT in consultation with the community (URL with the AR7 FastTrack configuration to come).
+the MBTT in consultation with the community (URL with the CMIP7 AFT configuration to come).
 
 The individual components of the REF have been designed to be useful for
-applications past the lifetime of the AR7 Fast Track.
+applications past the lifetime of the CMIP7 AFT.
 These components can be extended to support evaluating other types of climate data.
 The REF is agnostic to what types of data and metrics are to be performed.
 
@@ -103,7 +103,7 @@ These docker containers are not yet published, but can be built from the source
 docker-compose build
 ```
 
-An example docker-compose file is provided in the repository for the AR7 FastTrack deployment of the REF,
+An example docker-compose file is provided in the repository for the CMIP7 AFT deployment of the REF,
 using the Celery executor and Redis as the message broker.
 This can be run with:
 
diff --git a/changelog/251.docs.md b/changelog/251.docs.md
@@ -0,0 +1 @@
+Migrate from the use of ‘AR7 Fast Track’ to ‘Assessment Fast Track’ in response to the CMIP Panel decision to [change the name of the CMIP7 fast track](https://wcrp-cmip.org/fast-track-name-update/).
diff --git a/docs/background/architecture.md b/docs/background/architecture.md
@@ -1,6 +1,6 @@
 # Architecture
 
-The CMIP AR7 Fast Track REF aims to provide a community tool for the benchmarking of Earth System Models (ESMs)
+The CMIP7 Assessment Fast Track REF aims to provide a community tool for the benchmarking of Earth System Models (ESMs)
 against observational datasets as they are submitted.
 This near-real-time model evaluation will produce a set of scalar,
 timeseries or gridded diagnostics in combination with static web pages and figures that will be made publicly available.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -84,7 +84,7 @@ from the examples given in that link.
   ([#160](https://github.com/Climate-REF/climate-ref/pulls/160))
 - Add activity and institute to ESMValTool recipes to allow running with models
   and experiments that are not in the CMIP6 controlled vocabulary. ([#166](https://github.com/Climate-REF/climate-ref/pulls/166))
-- Add an integration test for the AR7 Fast-track metric providers.
+- Add an integration test for the CMIP7 AFT metric providers.
   This will be run nightly as part of the Climate-REF CI pipeline. ([#187](https://github.com/Climate-REF/climate-ref/pulls/187))
 - Improved the error message when running `ref datasets list` with the `--column` argument.
   If a column is specified that is not available, the error message now only mentions
diff --git a/docs/hackathon.md b/docs/hackathon.md
@@ -2,11 +2,13 @@
 
 **Hackathon at the Met Office, Exeter, UK, 10 - 14 May 2025**
 
-This hybrid hackathon is being run by the Model Benchmarking Task Team and the REF delivery team. We welcome attendance from technical and domain scientists from modelling centres involved in the CMIP AR7 Fast Track, observation dataset providers, as well as ESGF nodes and developers.
+This hybrid hackathon is being run by the Model Benchmarking Task Team and the REF delivery team.
+We welcome attendance from technical and domain scientists from modelling centres involved in the CMIP7 Assessment Fast Track (AFT),
+observation dataset providers, as well as ESGF nodes and developers.
 
 During the hackathon, there will also be dedicated drop-ins for wider community interest:
 
-* **10 March 14:00 UTC – 15:00 UTC**: Hackathon launch - providing a brief overview of the REF and a status update by the AR7 FT REF delivery team
+* **10 March 14:00 UTC – 15:00 UTC**: Hackathon launch - providing a brief overview of the REF and a status update by the CMIP AFT delivery team
 * **11 March 17:00 – 18:00 UTC**: Modelling Centres
 * **13 March 08:00 – 09:00 UTC**: Modelling Centres
 * **13 March 11:00 – Midday UTC**: Observation dataset providers
@@ -73,7 +75,7 @@ How a metric is actually calculated depends on which metrics provider the metric
 The rest of the complexity that comes from figuring out which datasets to use, how to run the metric, and how to visualise the results is handled by the REF.
 
 ### Metric Providers
-Metrics are grouped into packages, one for each of the metric providers selected for the AR7 Fast Track.
+Metrics are grouped into packages, one for each of the metric providers selected for the CMIP7 AFT.
 These metric packages (ESMValTool, ILAMB and PMP) each have different ways of calculating metrics.
 
 For some metric providers (ILAMB and ESMValTool),
diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -1,6 +1,6 @@
 # Roadmap
 
-Below is a high-level roadmap for the CMIP AR7 Fast Track REF  project towards the goal of a public release in October 2025.
+Below is a high-level roadmap for the CMIP7 Assessment Fast Track(AFT)  project towards the goal of a public release in October 2025.
 This roadmap outlines the key milestones and tasks that need to be completed to achieve this goal.
 
 We have broken down the roadmap into several sections to provide a clear overview of the project's progress.
@@ -23,7 +23,7 @@ Click on [] in the top right corner of the diagram to make it full screen.
 ```mermaid
 gantt
     dateFormat  YYYY-MM-DD
-    title       REF for AR7 Fast Track
+    title       REF for CMIP7 Assessment Fast Track
     excludes    weekends
 
     section Metrics
@@ -35,7 +35,7 @@ gantt
     Create ILAMB integration                      :done, ilamb, after metricsPrototype, 2025-01-20
     Create PMP integration                        :done, pmp, after metricsPrototype, 2025-03-04
 
-    Implement missing metrics                     :active, missing, after esmvaltool, 2025-04-01
+    Implement missing metrics                     :active, missing, after esmvaltool, 2025-05-14
     Incorporate missing reference datasets        :after beta, 4w
     Fixes                                         :after missing, 6w
 
@@ -50,16 +50,16 @@ gantt
     Conda-forge environments                      :conda, 2025-04-05, 3w
     Provider docker containers                    :after conda, 3w
     Develop a remote executor                     :done, celery, 2025-01-01, 30d
-    Ingest scalar results into database           :ingest, after results, 30d
-    Develop a remote executor (slurm)             :slurm, after hackathon, 10d
-    Ingest AR7 FT datasets                        :2025-04-20, 4w
+    Ingest scalar results into database           :active,ingest, after results, 30d
+    Develop a remote executor (slurm)             :slurm, 2025-04-20, 10d
+    Ingest CMIP7 AFT datasets                        :2025-06-01, 2w
 
     section Visualisation
 
     CMEC validation                               :done, cmec, 2025-01-15, 20d
     CMEC helpers                                  :done, cmecHelpers, after cmec, 4w
-    Basic API for results                         :active, results, 2025-03-01, 15d
-    Integrate Unified Dashboard                   :ud, after results, 20d
+    Basic API for results                         :done, results, 2025-03-01, 20d
+    Integrate Unified Dashboard                   :active, ud, after results, 20d
     Search results via API                        :api-result, after beta, 2w
     Example prototype dashboard                   :dashboad, after api-result, 6w
     Python package for consuming results          :after api-result, 4w
@@ -68,16 +68,16 @@ gantt
     section Testing
     Validate package licences                     :done, 2024-11-15, 2024-12-02
     Develop testing framework                     :done, 2024-11-10, 2024-12-10
-    Documentation and tutorials                   :active, 2025-03-06, 2025-04-01
-    Initial modelling center testing (MetOffice)  :active, mc1, 2025-03-10, 14d
-    Initial modelling center testing (MC 2)       :mc2, after mc1, 14d
-    Initial modelling center testing (MC 3)       :mc3, after mc1, 14d
-    MB TT stress-testing                          :2025-05-01, 20d
-    MB TT Documentation Review                    :2025-05-01, 20d
+    Documentation and tutorials                   :active, 2025-05-06, 2025-04-01
+    Initial modelling center testing (MetOffice)  :done, mc1, 2025-03-10, 14d
+    Initial modelling center testing (MC 2)       :mc2, 2025-05-10, 14d
+    Initial modelling center testing (MC 3)       :mc3, 2025-05-10, 14d
+    MB TT stress-testing                          :2025-05-10, 20d
+    MB TT Documentation Review                    :2025-05-20, 20d
 
     section Deployment
-    Discuss options with ESGF deployment          :active, esgf, 2024-12-01, 90d
-    Build K8 helm charts                          :helm, after 2025-04-01, 4w
+    Discuss options with ESGF deployment          :done, esgf, 2024-12-01, 90d
+    Build K8 helm charts                          :active, helm, after 2025-04-01, 4w
     ESGF Staging deployment for testing                :staging, after helm, 1w
     CMIP6 stress-test                             :after staging, 4w
     ESGF index integration                        :crit, after beta, 4w
@@ -92,7 +92,7 @@ gantt
     ESA CMUG Colocation                           :done, 2024-10-16, 3d
     Project Launch                                :done, 2024-11-04, 1d
     AGU                                           :done, 2024-12-01, 1w
-    Hackathon                                     :active, hackathon, 2025-03-10, 5d
+    Hackathon                                     :done, hackathon, 2025-03-10, 5d
     EGU                                           :egu, 2025-04-20, 1w
     Beta feature freeze                           :milestone, beta, 2025-05-01, 1d
     Beta Release                                  :milestone, beta, 2025-05-30, 1d
@@ -108,7 +108,7 @@ gantt
 
 An overview of the current state of the selected metrics can be found in the
 [Metrics Github board](https://github.com/orgs/Climate-REF/projects/2/views/2) document.
-This is being updated as the new metrics are integrated into the CMIP AR7 Fast Track REF.
+This is being updated as the new metrics are integrated into the CMIP7 AFT REF.
 
 
 ## What will be in the beta:
@@ -119,7 +119,7 @@ before a public release in October 2025 which will be deployed at ESGF.
 
 The beta will include the following features:
 
-* Ingesting local CMIP6, CMIP AR7 FT, obs4MIPs datasets
+* Ingesting local CMIP6, CMIP7 AFT, obs4MIPs datasets
     * We will include documention to allow users to ingest their own datasets (we welcome any contributions)
 * Examples of ESMValTool, ILAMB, and PMP metrics.
     * Some reference datasets may be missing as we are work through integrating these with obs4MIPs.
diff --git a/packages/ref-celery/src/cmip_ref_celery/executor.py b/packages/ref-celery/src/cmip_ref_celery/executor.py
@@ -1,3 +1,7 @@
+"""
+Executor for running metrics asynchronously using Celery
+"""
+
 import time
 from typing import Any
 
diff --git a/packages/ref-celery/src/cmip_ref_celery/worker_tasks.py b/packages/ref-celery/src/cmip_ref_celery/worker_tasks.py
@@ -1,3 +1,7 @@
+"""
+Celery worker tasks for handling metric execution results.
+"""
+
 from celery import current_app
 from loguru import logger
 
diff --git a/packages/ref-core/src/cmip_ref_core/__init__.py b/packages/ref-core/src/cmip_ref_core/__init__.py
@@ -1,5 +1,5 @@
 """
-Rapid evaluating CMIP data
+Rapid evaluating Climate data
 """
 
 import importlib.metadata
diff --git a/packages/ref-core/src/cmip_ref_core/constraints.py b/packages/ref-core/src/cmip_ref_core/constraints.py
@@ -1,3 +1,7 @@
+"""
+Dataset selection constraints
+"""
+
 import sys
 import warnings
 from collections import defaultdict
diff --git a/packages/ref-core/src/cmip_ref_core/dataset_registry.py b/packages/ref-core/src/cmip_ref_core/dataset_registry.py
@@ -2,8 +2,8 @@
 Data registries for non-published reference data
 
 These data are placeholders until these data have been added to obs4MIPs.
-The AR7 FT REF requires that reference datasets are openly licensed before it is included
-in any published data catalogs.
+The CMIP7 Assessment Fas Track REF requires that reference datasets are openly licensed
+before it is included in any published data catalogs.
 """
 
 import importlib.resources
diff --git a/packages/ref-core/src/cmip_ref_core/datasets.py b/packages/ref-core/src/cmip_ref_core/datasets.py
@@ -1,3 +1,7 @@
+"""
+Dataset management and filtering
+"""
+
 import enum
 import hashlib
 from collections.abc import Iterable
diff --git a/packages/ref-core/src/cmip_ref_core/exceptions.py b/packages/ref-core/src/cmip_ref_core/exceptions.py
@@ -1,3 +1,7 @@
+"""
+Custom exceptions
+"""
+
 from typing import Any
 
 
diff --git a/packages/ref-core/src/cmip_ref_core/executor.py b/packages/ref-core/src/cmip_ref_core/executor.py
@@ -1,3 +1,7 @@
+"""
+Executor interface for running metrics
+"""
+
 from typing import TYPE_CHECKING, Any, Protocol, runtime_checkable
 
 from cmip_ref_core.metrics import Metric, MetricExecutionDefinition
diff --git a/packages/ref-core/src/cmip_ref_core/metrics.py b/packages/ref-core/src/cmip_ref_core/metrics.py
@@ -1,3 +1,7 @@
+"""
+Metric interface
+"""
+
 from __future__ import annotations
 
 import pathlib
diff --git a/packages/ref-core/src/cmip_ref_core/providers.py b/packages/ref-core/src/cmip_ref_core/providers.py
@@ -2,6 +2,7 @@
 Interfaces for metrics providers.
 
 This defines how metrics packages interoperate with the REF framework.
+Each metrics package may contain multiple metrics.
 """
 
 from __future__ import annotations
diff --git a/packages/ref-core/src/cmip_ref_core/pycmec/cv_cmip7_aft.yaml b/packages/ref-core/src/cmip_ref_core/pycmec/cv_cmip7_aft.yaml
diff --git a/packages/ref/conftest.py b/packages/ref/conftest.py
@@ -43,15 +43,15 @@ def db(config) -> Database:
 
 
 @pytest.fixture(scope="session")
-def ar7_ft_cv() -> CV:
-    cv_file = str(importlib.resources.files("cmip_ref_core.pycmec") / "cv_cmip_ar7ft.yaml")
+def cmip7_aft_cv() -> CV:
+    cv_file = str(importlib.resources.files("cmip_ref_core.pycmec") / "cv_cmip7_aft.yaml")
 
     return CV.load_from_file(cv_file)
 
 
 @pytest.fixture(scope="session")
-def prepare_db(ar7_ft_cv):
-    MetricValue.register_cv_dimensions(ar7_ft_cv)
+def prepare_db(cmip7_aft_cv):
+    MetricValue.register_cv_dimensions(cmip7_aft_cv)
 
 
 @pytest.fixture(scope="session")
diff --git a/packages/ref/src/cmip_ref/config.py b/packages/ref/src/cmip_ref/config.py
@@ -120,7 +120,7 @@ class PathConfig:
     """
     Path to a file containing the controlled vocabulary for the dimensions in a CMEC metrics bundle
 
-    This defaults to the controlled vocabulary for the AR7-FT metrics,
+    This defaults to the controlled vocabulary for the CMIP7 Assessment Fast Track metrics,
     which is included in the `cmip_ref_core` package.
 
     This controlled vocabulary is used to validate the dimensions in the metrics bundle.
@@ -146,7 +146,7 @@ def _results_factory(self) -> Path:
 
     @dimensions_cv.default
     def _dimensions_cv_factory(self) -> Path:
-        filename = "cv_cmip_ar7ft.yaml"
+        filename = "cv_cmip7_aft.yaml"
         return Path(str(importlib.resources.files("cmip_ref_core.pycmec") / filename))
 
 
diff --git a/packages/ref/tests/unit/models/test_metric_value.py b/packages/ref/tests/unit/models/test_metric_value.py
@@ -36,7 +36,7 @@ def test_invalid_dimension(self, db_seeded):
                 dimensions={"not_a_dimension": "test"},
             )
 
-    def test_register_dimensions(self, ar7_ft_cv):
+    def test_register_dimensions(self, cmip7_aft_cv):
         metric_value_kwargs = dict(
             metric_execution_result_id=1, value=1.0, attributes=None, dimensions={"model": "test"}
         )
@@ -46,21 +46,21 @@ def test_register_dimensions(self, ar7_ft_cv):
         with pytest.raises(KeyError):
             MetricValue.build(**metric_value_kwargs)
 
-        MetricValue.register_cv_dimensions(ar7_ft_cv)
-        assert MetricValue._cv_dimensions == [d.name for d in ar7_ft_cv.dimensions]
+        MetricValue.register_cv_dimensions(cmip7_aft_cv)
+        assert MetricValue._cv_dimensions == [d.name for d in cmip7_aft_cv.dimensions]
 
         # Should work now that the dimension has been registered
         item = MetricValue.build(**metric_value_kwargs)
 
         for k in MetricValue._cv_dimensions:
             assert hasattr(item, k)
 
-    def test_register_dimensions_multiple_times(self, ar7_ft_cv):
+    def test_register_dimensions_multiple_times(self, cmip7_aft_cv):
         MetricValue._reset_cv_dimensions()
         assert MetricValue._cv_dimensions == []
 
-        MetricValue.register_cv_dimensions(ar7_ft_cv)
-        assert MetricValue._cv_dimensions == [d.name for d in ar7_ft_cv.dimensions]
+        MetricValue.register_cv_dimensions(cmip7_aft_cv)
+        assert MetricValue._cv_dimensions == [d.name for d in cmip7_aft_cv.dimensions]
 
-        MetricValue.register_cv_dimensions(ar7_ft_cv)
-        assert MetricValue._cv_dimensions == [d.name for d in ar7_ft_cv.dimensions]
+        MetricValue.register_cv_dimensions(cmip7_aft_cv)
+        assert MetricValue._cv_dimensions == [d.name for d in cmip7_aft_cv.dimensions]
diff --git a/packages/ref/tests/unit/test_config.py b/packages/ref/tests/unit/test_config.py
@@ -157,7 +157,7 @@ def test_defaults(self, monkeypatch, mocker):
                 "results": f"{default_path}/results",
                 "scratch": f"{default_path}/scratch",
                 "software": f"{default_path}/software",
-                "dimensions_cv": str(Path("pycmec") / "cv_cmip_ar7ft.yaml"),
+                "dimensions_cv": str(Path("pycmec") / "cv_cmip7_aft.yaml"),
             },
             "db": {"database_url": "sqlite:///test/db/cmip_ref.db", "run_migrations": True},
         }
diff --git a/scripts/ingest-solve.sh b/scripts/ingest-solve.sh
@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# Test script for ingesting and solving the AR7 FT set of providers
+# Test script for ingesting and solving the CMIP7 Assessment Fast Track set of providers
 # Uses the sample data
 # WARNING this deletes your existing database
 
diff --git a/tests/integration/test_cmip7_aft.py b/tests/integration/test_cmip7_aft.py
@@ -31,9 +31,9 @@ def create_execution_dataframe(executions: Iterable[MetricExecutionGroup]) -> pd
 
 
 @pytest.fixture
-def config_ar7_ft(config):
+def config_cmip7_aft(config):
     """
-    Overwrite the default test config to use the metric providers for AR7 FT
+    Overwrite the default test config to use the metric providers for CMIP7 Assessment Fast Track
     """
     # Force the default metric providers
     config.metric_providers = default_metric_providers()
@@ -46,19 +46,19 @@ def config_ar7_ft(config):
 
 
 @pytest.mark.slow
-def test_solve_ar7_ft(
+def test_solve_cmip7_aft(
     sample_data_dir,
-    config_ar7_ft,
+    config_cmip7_aft,
     invoke_cli,
     monkeypatch,
 ):
     # Arm-based MacOS users will need to set the environment variable `MAMBA_PLATFORM=osx-64`
     if platform.system() == "Darwin" and platform.machine() == "arm64":
         monkeypatch.setenv("MAMBA_PLATFORM", "osx-64")
 
-    assert len(config_ar7_ft.metric_providers) == 3
+    assert len(config_cmip7_aft.metric_providers) == 3
 
-    db = Database.from_config(config_ar7_ft)
+    db = Database.from_config(config_cmip7_aft)
 
     # Ingest the sample data
     invoke_cli(["datasets", "ingest", "--source-type", "cmip6", str(sample_data_dir / "CMIP6")])

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`CMIP Rapid Evaluation Framework`
`2`	`2`
`3`		`-Copyright 2024- AR7 Fast Track REF Technical Implementation Team`
	`3`	`+Copyright 2024- CMIP7 Assessment Fast Track REF Technical Implementation Team`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Migrate from the use of ‘AR7 Fast Track’ to ‘Assessment Fast Track’ in response to the CMIP Panel decision to [change the name of the CMIP7 fast track](https://wcrp-cmip.org/fast-track-name-update/).`