Migrate to the CI being the source of truth

.github/actions/regenerate/action.yml

@@ -1,6 +1,5 @@
 name: "Regenerate sample data"
 description: "Runs the regenerate sample data workflow and commits the result"
-
 runs:
   using: "composite"
   steps:

.github/pull_request_template.md

@@ -4,6 +4,6 @@
 
 Please confirm that this pull request has done the following:
 
-- [ ] Tests added
+- [ ] Data registry up to date (regenerate if necessary with a comment on this PR of `/regenerate`)
 - [ ] Documentation added (where applicable)
 - [ ] Changelog item added to `changelog/`

.github/workflows/ci.yaml

@@ -39,7 +39,7 @@ jobs:
 
       - name: Verify registry
         run: |
-          make registry.txt
+          make fetch-test-data
           git diff --exit-code
 
   # Check if a changelog message was added to the PR

README.md

@@ -5,8 +5,32 @@
 
 **Status**: This project is in active development. We expect to be ready for beta releases in Q2 2025.
 
-The CMIP Rapid Evaluation Framework is a Python application that provides the ability to rapidly process and
-evaluate CMIP data against a set of reference data.
+The [CMIP Rapid Evaluation Framework](https://github.com/CMIP-REF/cmip-ref) is a Python application
+that provides the ability to rapidly process and evaluate CMIP data against a set of reference data.
 This repository contains a set of sample data that can be used to test the REF.
 
 CMIP REF is a community project, and we welcome contributions from anyone.
+
+## Getting started
+
+The sample data is stored in the `data` directory.
+The data is stored in a directory structure that mirrors the structure of the data on the ESGF,
+but each file contains only a subset of the data.
+The `registry.txt` file contains a list of the datasets that are included in the sample data and their hashes.
+These data are fetched by the REF's test suite to ensure a consistent collection of input datasets are used for testing.
+
+The data that are tracked and the decimation process is described in: [scripts/fetch_test_data.py]()
+
+
+### Regenerating the sample data
+
+The binary content of the generated sample data may vary by platform and various other dependencies.
+In order to ensure that the hashes are consistent across platforms,
+the hashes are generated on the CI and stored in the `registry.txt` file.
+These hashes are verified as part of the CI pipeline to ensure that the data is consistent.
+
+If the hashes in the `registry.txt` file are out of date,
+you can regenerate the sample data by adding a comment to an open Pull Request with the text `/regenerate`.
+This will trigger a [GitHub Actions workflow](https://github.com/CMIP-REF/ref-sample-data/actions/workflows/pr-comment.yaml)
+that will regenerate the sample data and update the `registry.txt` file.
+Be sure to pull the new commit if you need to add any additional changes to your pull request.

changelog/7.feature.md

@@ -1,3 +1,3 @@
 Added an action to regenerate the sample data in Pull Requests.
 
-A comment containing `\regenerate` will trigger the action.
+A comment containing `/regenerate` will trigger the action.

changelog/8.fix.md

@@ -0,0 +1 @@
+Migrates the source of truth for data generation to the server and documented the regeneration flow

registry.txt

@@ -1,13 +1,13 @@
-CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/rlut/gn/v20191115/rlut_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc 95341df80de95ddb0b45da11aed67db771414fff94508687fb30fce63b82c104
-CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/rsdt/gn/v20191115/rsdt_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc 25e9e817a05ffab4a2b073078f6be0e52096fa9da8eb55f009d079842c708614
-CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/rsut/gn/v20191115/rsut_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc 139c4c59d98c737ce2d7ca777e52e35e38d49fcb8b08dd98175ed0f1354f8e75
-CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/tas/gn/v20191115/tas_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc be4a191c75b3643aad34238970c0587128a3852694f2c61425b4bbda42e5ff08
-CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/fx/areacella/gn/v20191115/areacella_fx_ACCESS-ESM1-5_historical_r1i1p1f1_gn.nc d9d07cacc65c196b9ec47d60cabcf86fd397b1e22063a32c3798a98ee3dfb16e
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rlut/gn/v20210318/rlut_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc 1083d92079e9c40d3797ecc4235df1c86c99af7ca3b9458b21f1d34054351041
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsdt/gn/v20210318/rsdt_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_201501-210012.nc 9f9ae50efc55f4e18dc174d7c3af10f4e67a391c84d81cdb6ba574fa8b61b276
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsdt/gn/v20210318/rsdt_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc 2299e10eb6ccf190fe07f7b60aa40b8700f7f964ca68c989f3572abe39eb22c7
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsut/gn/v20210318/rsut_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_201501-210012.nc 5141bb64d6f457550d8bf429a4233af1bd706ed8b2131fc2ef329bcb6db7a236
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsut/gn/v20210318/rsut_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc 49fbd6c0d7b8c0d10a270e8d88191764c02ba651f80b464605dfa5b0221d622b
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/tas/gn/v20210318/tas_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_201501-210012.nc bff52adef26d48d4b747368816aff3712c606cafa92f6b78f4974f23efcba510
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/tas/gn/v20210318/tas_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc b61faa48540472be5b208a4ecf40873860c1d4cfb7f50a4dff4ac17ee2ba4f73
-CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/fx/areacella/gn/v20210318/areacella_fx_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn.nc e8e3b873d9ba115974329c0f7785c9e30dcca66007fa973c22cd734efc46dcfd
+CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/rlut/gn/v20191115/rlut_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc 3d5e70004253f4973cb07265373bfb63f4c7fba25e2a048b300a5eba1b6dad56
+CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/rsdt/gn/v20191115/rsdt_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc 8c80ab4f64ad31caf0d7743984d0f6f1a23c961beeb23e41e96e457422643e7a
+CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/rsut/gn/v20191115/rsut_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc 13c2c3e0f42cbad60e4096d3dc8ac96e867880d4f10742ec635f9648fe16e298
+CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/Amon/tas/gn/v20191115/tas_Amon_ACCESS-ESM1-5_historical_r1i1p1f1_gn_185001-201412.nc f07bc7bc43712a160626b18f660a244be21cfd8fe3b4488def9b4d002007212e
+CMIP6/CMIP/CSIRO/ACCESS-ESM1-5/historical/r1i1p1f1/fx/areacella/gn/v20191115/areacella_fx_ACCESS-ESM1-5_historical_r1i1p1f1_gn.nc 85a64eacd4c38f25ede96ce644f654e98596ff5aed0c521681b27fef0bc7a6b3
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rlut/gn/v20210318/rlut_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc 3770c7856ebbd1c4888d3267d176e37ed6659883ab04fe319bcf090b9a2112e5
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsdt/gn/v20210318/rsdt_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_201501-210012.nc 5e322846c0308d793169044a4bdc05c1686ce7ba335b453194c353a142b4d94f
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsdt/gn/v20210318/rsdt_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc 5076b51d075029a038ca3af981d9cede902eec9bf667767a232b87fba1cb1e8c
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsut/gn/v20210318/rsut_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_201501-210012.nc 10a9431638626c0358be581c6fcc96bd4a0f2051ab9ae92be3e43811f149ee63
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/rsut/gn/v20210318/rsut_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc 43d68491eada7b2cf1adf11170346584af1662c0472eafe8180ab6965752bcd8
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/tas/gn/v20210318/tas_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_201501-210012.nc 4bdd770ccf0c305284f4b7df30da11be9b463a734498da627ab99d10067cd9a7
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/Amon/tas/gn/v20210318/tas_Amon_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn_210101-230012.nc a33f0c940a8ef87bba0ccceb43f174df31e9635d5806f2b3aea07468f17592ec
+CMIP6/ScenarioMIP/CSIRO/ACCESS-ESM1-5/ssp126/r1i1p1f1/fx/areacella/gn/v20210318/areacella_fx_ACCESS-ESM1-5_ssp126_r1i1p1f1_gn.nc b1bee7c317e19f68d5bdbb60b3485badb99cc32bc3859f970d01dc28a57a14da