CMIP6 Participation for Data Managers

1. ESGF stack installation & upgrade

This section describes the procedure a data node administrator have to follow to install or to update an ESGF data node.

  1. Documentation

2. Configuring data/metadata publication on the data node

This section describes the prerequisite steps that need to be carefully follow to configure CMIP6 data publication on the data node side.

  1. Prepare esg.ini file
  2. How to
  3. Fetch project .ini files (optional)
  4. Get ES-DOC credentials for CDF2CIM
  5. How to
  6. Check for the completion of data citation information

3. Configuring data publication on the index node (Tiers 1 site only)

This section describes the prerequisite steps that need to be carefully follow to configure CMIP6 data publication on the index node side.

  1. Prepare user and permissions for publication
  2. Setup data access control
  3. How to

4. Configuring ESGF data usage metrics through the esgf-dashboard

This section describes how to configure the metrics collection on the data node.

  1. Documentation
  2. Configuration

5. Configuring CoG (Tiers 1 site only)

This section describes how to configure the CoG front end so that the CMIP6 CoG pages and the associated search works as expected.

  1. How to log onto CoG as Node administrator
  2. How to set up the Node “home” project
  3. Example of Node home page
  4. How to configure the search for a CoG project
  5. How to configure your CoG to federate with other CoGs
  6. How to customize the CoG header and footer
  7. How to post a header on top of CoG pages for a special announcement

6. Validation with ESGF test suite

This section describes the usage of the ESGF test suite that will validate that a data or index node is working as expected. This test-suite should be run after the installation and configuration phase has been completed.

  1. Documentation

7. Configuring data access on the data node

This section describes prerequisite steps needed to apply the appropriate policies to the data access.

  1. Documentation
  2. How to

8. (Optional) Checking and fixing CMIP time coordinate

This section describes a tools that permits the data provider to check the consistency of time axis coordinates across several files. Having this quality control well ahead of your data publication step can save you a lot of time.

  1. Install nctime
  2. (Optional) Fetch project .ini files
  3. Check time axis squareness
  4. Check time coverage continuity
  5. CMIP6 Example

9. (Optional) Running PrePARE standalone

This section describes how to configure the PrePARE quality control tool independently from the ESGF publisher. Having this quality control well ahead of your data publication step can save you a lot of time.

  1. Install PrePARE
  2. Fetch CMIP6 CMOR tables
  3. Check CMIP6 files against CMOR tables and WCRP CV

10. Preparing directory structure and files organization to fulfill CMIP6

This section describes the usage of the esgprep tool. This tool will take of your CMIP data directory structure and will greatly ease dataset version management.

  1. Install esgprep
  2. (Optional) Fetch project .ini files
  3. List the datasets related to incoming files
  4. (Optional) Display the expected directory tree
  5. (Optional) List Unix commands to apply
  6. Upgrade your DRS tree

11. Publishing a CMIP6 dataset for the first time

This section describe steps required to publish the first version of a new CMIP6 dataset. After those steps your CMIP6 dataset will be findable and accessible from the ESGF portal.

Note on publishing: please do not manually edit esg.cmip6.ini to add missing information if your data files won’t publish. In such a case, it is likely that either the model is unregistered or there is an error in the metadata that needs to be corrected. Please contact (1) the modeling group to ensure all fields are properly registered ; (2) support from CDNOT to get the publisher config (esg.cmip6.ini file) updated. See (https://github.com/WCRP-CMIP/CMIP6_CVs/) for the most up-to-date catalog of registered entities (source_id, institution_id, etc.)

  1. Check for the completion of data citation information
  2. (Optional) Fetch project .ini files
  3. Generate mapfiles
  4. Generate certificate for publication

The following steps are for users of the esgpublisher version(s) 4.x and older. If you have upgraded esg-publisher (esgcet) to v5.x or interested in doing so, then skip to the last step (j.).

  1. Check the [config:cmip6] section of your esg.ini file
  2. Publish to local PostgreSQL database
  3. Publish to local THREDDS server
  4. Publish to the index node
  5. How to

For users who have upgraded to version 5.x or plan to, installation, configuration and usage are covered here:

  1. Publishing using the v5.x version of esg-publisher / esgpublish

12. Describe datasets issues and errata using the errata service

This section describes how data providers can describe issues affecting datasets they have published to ESGF for CMIP6.

  1. Log in to the Errata Service
  2. Create an issue
  3. Update an issue
  4. Close an issue
  5. The errata client CLI

13. Unpublish data (before new version is ready)

This section describes the step you need to follow to withdraw a CMIP6 dataset from ESGF.

  1. (Mandatory) Follow errata workflow
  2. Unpublish a dataset
  3. How to

14. Publishing a new version of a CMIP6 dataset

This section describes the step you need to take to publish a new version of a CMIP6 dataset on ESGF. Old version will still be accessible but the latest version will appear first by default.

  1. (Mandatory) Create an errata explaining the reason of this new version
  2. List the new dataset version related to corrected files
  3. Upgrade your DRS tree from latest version
  4. Generate new mapfiles
  5. Follow publication workflow a usual
Document version: 29 January 2020