Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is a guide to ESGF publication for E3SM data. This guide is not meant to work for publication to CMIP6.

This guide assumes you have your model data ready.

Step 1: Data

...

Selection

The first step is to decide what data you want to publish. For the piControl run (the first large E3SM publication) we decided to publish the following files:

  1. Atmosphere

  • Native cam.h0
  • Regridded cam.h0Regridded climotologies
  • Regridded time series (of select variables)
  1. Land
  • Native clm2.h0
  • Regridded clm2.h0
  1. Ocean
  • Native mpaso.hist.am.timeSeriesStatsMonthly

...

Once you've decided on what data to publish, generate the post processed data to meet your requirements (time series, regridded data, climos, ect).

ESGF requires that the data facets be stored in an "ini" file, which is used by the publisher to discover and validate the files. The E3SM ini file can be found here: /wiki/spaces/WORKFLOW/pages/650707592 and on GitHub: https://github.com/ESGF/config/blob/devel/publisher-configs/ini/esg.e3sm.ini

...

Code Block
directory_format = %(root)s/%(source)s/%(model_version)s/%(experiment)s/%(atmos_grid_resolution)s_atm_%(ocean_grid_resolution)s_ocean/%(realm)s/%(regridding)s/%(data_type)s/%(time_frequency)s/%(ensemble_member)s
dataset_id = %(source)s.%(model_version)s.%(experiment)s.%(atmos_grid_resolution)s_atm_%(ocean_grid_resolution)s_ocean.%(realm)s.%(regridding)s.%(data_type)s.%(time_frequency)s.%(ensemble_member)s

========= BUG WARNING ===========

DO NOT include any option values that include any substrings that match a 'v' followed by any numbers. No 'fv129x256' or 'v1_0' for model version.

This will break version parser in esgprep and cause it to not match any of your data.

=================================


Step 2: Data formatting

Once you've defined that structure of the dataset, the next step is fairly straightforward. Simply create the directories in the structure you defined, and place the correct data into the structure where it should go.

...

Code Block
esgmapfile make --outdir <path_to_yourput_output>mapfiles> -i <path_to_ini_directory> --project e3sm --max-processes <sum_number<number_of_cores> <path_to_your_new_data_set>

...