esgprep works according to
the configuration INI file(s) of the ESGF nodes.
On an ESGF node, the configuration directory containing those INI files is
/esg/config/esgcet, that is the default
esgprep. In the case you are running
esgprep outside of an ESGF node, the directory gathering all
files has to be submitted using the
-i option (see Generic usage).
This INI file gathers all required information to configure the datanode regarding to data publication (e.g., PostgreSQL access, THREDDS configuration, etc.).
The only configuration in this section is to define the checksum client and checksum
type under the
[default] section. Edit the file to set the Shell command line to use (default is
[default] checksum = sha256sum | SHA256
esg.ini is unfound, the default is SHA256.
Those INI files declare all facets and allowed values according to the Data Reference Syntax (DRS) and the controlled
vocabularies of the corresponding project. Preset
esg.<project_id>.ini files have been properly built by
ESGF community for the following projects:
- Please follow the structure detailed here.
- Add your project into the
project_optionslist of your
esgprepdirectly refers to the
project_id(i.e., requires lowercase).
directory_formatattribute is required for auto-detection and uses a regular expression to match with the full path of the files.
- All facets of the
dataset_idare not necessarily found in the
- All common facets to the
directory_formatmust have the same name.
- If a facet is missing in
directory_formatto allow the
dataset_idfilling, declare the appropriate
facet_map. The maptable uses the value of a declared facet to map the value of another missing facet in the
- The missing facet has to be declared as a “destination” key (i.e., on the right of the colon).
- Duplicated lines cannot occur in a maptable.
- A facet has to have at least one options list or maptable.
mapfile_drsattribute can be added to your project section to organize related mapfiles.
- Make sure the
directory_formatoptions reflect your directory structure accordingly.
Feel free to submit your own
esg.<project_id>.ini in order to add it to the GitHub repository and make
it available trough