Merge pull request #151 from PCMDI/cmip-source-ids

Add source IDs for use in various CMIP7 phases
PCMDI · Nov 14, 2024 · 620cd69 · 620cd69
2 parents 05b6bf5 + 4fde037
commit 620cd69
Show file tree

Hide file tree

Showing 19 changed files with 1,183 additions and 125 deletions.
diff --git a/changelog/151.docs.md b/changelog/151.docs.md
@@ -0,0 +1 @@
+Added information about which source ID to use for which phase of CMIP7 in the [dataset overviews][dataset-overviews] section.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -91,6 +91,16 @@ If you are working elsewhere, you may need to modify the paths slightly.
 1. Update the database: `python python-packages/input4MIPs-CVs/src/input4MIPs_CVs/cli/update-database.py --repo-root-dir .`
 1. Update the HTML pages: `python python-packages/input4MIPs-CVs/src/input4MIPs_CVs/cli/update-html-pages.py --repo-root-dir .`
 1. Check that the HTML has updated as expected (e.g. the summary view has updated as expected, new datasets are in the datasets view, new files are in the files view)
+1. Commit everything
+1. Build the docs: `mkdocs build --strict` 
+1. Check that the docs updated as expected. 
+   A few of the auto-generated components are worth checking here:
+
+    - are the source IDs for the dataset up to date? 
+      E.g. do we need to update the source IDs to be used for the various CMIP7 phases in 
+      `docs/dataset-overviews/cmip7_phases_source_ids.csv`?
+    - did the revision history come through correctly? If not, there is an issue.
+
 1. Commit everything
 1. Push
 1. Make a pull request

diff --git a/docs/dataset-overviews/aerosol-optical-properties-macv2-sp.md b/docs/dataset-overviews/aerosol-optical-properties-macv2-sp.md
@@ -1,3 +1,6 @@
+<!--- These values are used by `fill-out-auto-generated-sections.py` -->
+<!--- forcing="Aerosol optical properties/MACv2-SP" -->
+<!--- source_id_stub="tbd" -->
 # Aerosol optical properties/MACv2-SP
 
 **This section is a work in progress.**
@@ -8,7 +11,49 @@
 - Names: Stephanie Fielder
 - Emails: \[TBD (provider moving institutes)\]
 
-<!--- begin-revision-history:tbd -->
-<!--- Do not edit this section, it is automatically updated when the docs are filled out -->
+## Summary
+
+<!--- begin-cmip7-phases-source-ids -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
+### Source IDs for CMIP7 phases
+
+The source ID that identifies the dataset to use in the different phases of CMIP7 is given below.
+
+#### Testing
+
+No data available for this phase yet.
+
+This data is for testing purposes only.
+Production simulations should not be started based on this data.
+(As a further bit of context, you can tell that this is testing data because it has a `mip_era` metadata value of 'CMIP6Plus'.
+This metadata value appears both in the file's global metadata as well as its metadata on ESGF.)
+
+If you have any feedback, please add it to the [relevant GitHub discussion](https://github.com/PCMDI/input4MIPs_CVs/discussions).
+
+#### AR7 fast track
+
+No data available for this phase yet.
+
+This data will be for the AR7 fast track.
+All data sets for use in the fast track will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow in early 2025.
+
+#### CMIP7
+
+No data available for this phase yet.
+
+This data will be for CMIP7.
+All data sets for use in CMIP7 will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow after the fast track is underway
+(including details about how updates to this data will be handled over the lifetime of CMIP7).
+
+<!--- end-cmip7-phases-source-ids -->
+
+<!--- begin-revision-history -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
 <!--- No revisions, hence section is blank -->
 <!--- end-revision-history -->
diff --git a/docs/dataset-overviews/amip-sst-sea-ice-boundary-forcing.md b/docs/dataset-overviews/amip-sst-sea-ice-boundary-forcing.md
@@ -1,3 +1,6 @@
+<!--- These values are used by `fill-out-auto-generated-sections.py` -->
+<!--- forcing="AMIP sea-surface temperature and sea-ice boundary forcing" -->
+<!--- source_id_stub="PCMDI-ACMIP" -->
 # AMIP sea-surface temperature and sea-ice boundary forcing
 
 **This section is a work in progress.**
@@ -8,7 +11,49 @@
 - Names: Paul Durack
 - Emails: durack1@llnl.gov
 
-<!--- begin-revision-history:PCMDI-ACMIP -->
-<!--- Do not edit this section, it is automatically updated when the docs are filled out -->
+## Summary
+
+<!--- begin-cmip7-phases-source-ids -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
+### Source IDs for CMIP7 phases
+
+The source ID that identifies the dataset to use in the different phases of CMIP7 is given below.
+
+#### Testing
+
+No data available for this phase yet.
+
+This data is for testing purposes only.
+Production simulations should not be started based on this data.
+(As a further bit of context, you can tell that this is testing data because it has a `mip_era` metadata value of 'CMIP6Plus'.
+This metadata value appears both in the file's global metadata as well as its metadata on ESGF.)
+
+If you have any feedback, please add it to the [relevant GitHub discussion](https://github.com/PCMDI/input4MIPs_CVs/discussions).
+
+#### AR7 fast track
+
+No data available for this phase yet.
+
+This data will be for the AR7 fast track.
+All data sets for use in the fast track will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow in early 2025.
+
+#### CMIP7
+
+No data available for this phase yet.
+
+This data will be for CMIP7.
+All data sets for use in CMIP7 will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow after the fast track is underway
+(including details about how updates to this data will be handled over the lifetime of CMIP7).
+
+<!--- end-cmip7-phases-source-ids -->
+
+<!--- begin-revision-history -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
 <!--- No revisions, hence section is blank -->
 <!--- end-revision-history -->
diff --git a/docs/dataset-overviews/anthropogenic-slcf-co2-emissions.md b/docs/dataset-overviews/anthropogenic-slcf-co2-emissions.md
@@ -1,3 +1,6 @@
+<!--- These values are used by `fill-out-auto-generated-sections.py` -->
+<!--- forcing="Anthropogenic short-lived climate forcer (SLCF) and CO<sub>2</sub> emissions" -->
+<!--- source_id_stub="CEDS-CMIP" -->
 # Anthropogenic short-lived climate forcer (SLCF) and CO<sub>2</sub> emissions
 
 **This section is a work in progress.**
@@ -8,7 +11,49 @@
 - Names: Rachel Hoesly, Steve Smith
 - Emails: rachel.hoesly@pnnl.gov; ssmith@pnnl.gov
 
-<!--- begin-revision-history:CEDS-CMIP -->
-<!--- Do not edit this section, it is automatically updated when the docs are filled out -->
+## Summary
+
+<!--- begin-cmip7-phases-source-ids -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
+### Source IDs for CMIP7 phases
+
+The source ID that identifies the dataset to use in the different phases of CMIP7 is given below.
+
+#### Testing
+
+For the testing of CMIP7, use data with the source ID [CEDS-CMIP-2024-10-21](https://aims2.llnl.gov/search?project=input4MIPs&versionType=all&&activeFacets=%7B%22source_id%22%3A%22CEDS-CMIP-2024-10-21%22%7D)
+
+This data is for testing purposes only.
+Production simulations should not be started based on this data.
+(As a further bit of context, you can tell that this is testing data because it has a `mip_era` metadata value of 'CMIP6Plus'.
+This metadata value appears both in the file's global metadata as well as its metadata on ESGF.)
+
+If you have any feedback, please add it to the [relevant GitHub discussion](https://github.com/PCMDI/input4MIPs_CVs/discussions).
+
+#### AR7 fast track
+
+No data available for this phase yet.
+
+This data will be for the AR7 fast track.
+All data sets for use in the fast track will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow in early 2025.
+
+#### CMIP7
+
+No data available for this phase yet.
+
+This data will be for CMIP7.
+All data sets for use in CMIP7 will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow after the fast track is underway
+(including details about how updates to this data will be handled over the lifetime of CMIP7).
+
+<!--- end-cmip7-phases-source-ids -->
+
+<!--- begin-revision-history -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
 <!--- No revisions, hence section is blank -->
 <!--- end-revision-history -->
diff --git a/docs/dataset-overviews/cmip7_phases_source_ids.csv b/docs/dataset-overviews/cmip7_phases_source_ids.csv
@@ -0,0 +1,37 @@
+forcing_int_id,forcing,cmip7_phase,source_id_stub,source_id_stub_ignore,source_id,ok_if_not_latest
+1,Anthropogenic short-lived climate forcer (SLCF) and CO<sub>2</sub> emissions,testing,CEDS-CMIP,supplemental,CEDS-CMIP-2024-10-21,False
+1,Anthropogenic short-lived climate forcer (SLCF) and CO<sub>2</sub> emissions,ar7_fast_track,CEDS-CMIP,supplemental,,False
+1,Anthropogenic short-lived climate forcer (SLCF) and CO<sub>2</sub> emissions,cmip7,CEDS-CMIP,supplemental,,False
+2,Open biomass burning emissions,testing,DRES-CMIP-BB4CMIP7,,DRES-CMIP-BB4CMIP7-1-0,False
+2,Open biomass burning emissions,ar7_fast_track,DRES-CMIP-BB4CMIP7,,,False
+2,Open biomass burning emissions,cmip7,DRES-CMIP-BB4CMIP7,,,False
+3,Land use,testing,UofMD-landState,,UofMD-landState-3-0,False
+3,Land use,ar7_fast_track,UofMD-landState,,,False
+3,Land use,cmip7,UofMD-landState,,,False
+4,Greenhouse gas concentrations,testing,CR-CMIP,,CR-CMIP-0-3-0,False
+4,Greenhouse gas concentrations,ar7_fast_track,CR-CMIP,,,False
+4,Greenhouse gas concentrations,cmip7,CR-CMIP,,,False
+5,CO<sub>2</sub> isotopes,testing,,,,False
+5,CO<sub>2</sub> isotopes,ar7_fast_track,,,,False
+5,CO<sub>2</sub> isotopes,cmip7,,,,False
+6,Stratospheric volcanic SO<sub>2</sub> emissions and aerosol optical properties,testing,UOEXETER-CMIP,,UOEXETER-CMIP-1-1-3,False
+6,Stratospheric volcanic SO<sub>2</sub> emissions and aerosol optical properties,ar7_fast_track,UOEXETER-CMIP,,,False
+6,Stratospheric volcanic SO<sub>2</sub> emissions and aerosol optical properties,cmip7,UOEXETER-CMIP,,,False
+7,Ozone,testing,,,,False
+7,Ozone,ar7_fast_track,,,,False
+7,Ozone,cmip7,,,,False
+8,Nitrogen deposition,testing,,,,False
+8,Nitrogen deposition,ar7_fast_track,,,,False
+8,Nitrogen deposition,cmip7,,,,False
+9,Solar,testing,SOLARIS-HEPPA-CMIP,,SOLARIS-HEPPA-CMIP-4-4,False
+9,Solar,ar7_fast_track,SOLARIS-HEPPA-CMIP,,,False
+9,Solar,cmip7,SOLARIS-HEPPA-CMIP,,,False
+10,AMIP sea-surface temperature and sea-ice boundary forcing,testing,,,,False
+10,AMIP sea-surface temperature and sea-ice boundary forcing,ar7_fast_track,,,,False
+10,AMIP sea-surface temperature and sea-ice boundary forcing,cmip7,,,,False
+11,Aerosol optical properties/MACv2-SP,testing,,,,False
+11,Aerosol optical properties/MACv2-SP,ar7_fast_track,,,,False
+11,Aerosol optical properties/MACv2-SP,cmip7,,,,False
+12,Population density,testing,,,,False
+12,Population density,ar7_fast_track,,,,False
+12,Population density,cmip7,,,,False
diff --git a/docs/dataset-overviews/co2-isotopes.md b/docs/dataset-overviews/co2-isotopes.md
@@ -1,3 +1,6 @@
+<!--- These values are used by `fill-out-auto-generated-sections.py` -->
+<!--- forcing="CO<sub>2</sub> isotopes" -->
+<!--- source_id_stub="tbd" -->
 # CO<sub>2</sub> isotopes
 
 **This section is a work in progress.**
@@ -8,7 +11,49 @@
 - Names: Heather Graven
 - Emails: h.graven@imperial.ac.uk
 
-<!--- begin-revision-history:tbd -->
-<!--- Do not edit this section, it is automatically updated when the docs are filled out -->
+## Summary
+
+<!--- begin-cmip7-phases-source-ids -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
+### Source IDs for CMIP7 phases
+
+The source ID that identifies the dataset to use in the different phases of CMIP7 is given below.
+
+#### Testing
+
+No data available for this phase yet.
+
+This data is for testing purposes only.
+Production simulations should not be started based on this data.
+(As a further bit of context, you can tell that this is testing data because it has a `mip_era` metadata value of 'CMIP6Plus'.
+This metadata value appears both in the file's global metadata as well as its metadata on ESGF.)
+
+If you have any feedback, please add it to the [relevant GitHub discussion](https://github.com/PCMDI/input4MIPs_CVs/discussions).
+
+#### AR7 fast track
+
+No data available for this phase yet.
+
+This data will be for the AR7 fast track.
+All data sets for use in the fast track will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow in early 2025.
+
+#### CMIP7
+
+No data available for this phase yet.
+
+This data will be for CMIP7.
+All data sets for use in CMIP7 will be published with a `mip_era` metadata value of 'CMIP7'.
+This metadata value will appear both in the file's global metadata as well as its metadata on ESGF.
+
+Further details will follow after the fast track is underway
+(including details about how updates to this data will be handled over the lifetime of CMIP7).
+
+<!--- end-cmip7-phases-source-ids -->
+
+<!--- begin-revision-history -->
+<!--- Do not edit this section, it is automatically updated when the docs are built -->
 <!--- No revisions, hence section is blank -->
 <!--- end-revision-history -->
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Added information about which source ID to use for which phase of CMIP7 in the [dataset overviews][dataset-overviews] section.