Commit c78d82c3 authored by Mathis Rosenhauer's avatar Mathis Rosenhauer
Browse files

Expand CMOR docs

parent 4f5dfcee
......@@ -15,11 +15,12 @@ and writes them directly with the CMOR library.
Each output file contains a single output variable with there coordinates and metadata.
Much of the metadata written to the output files is defined in the table file.
The name of the output files are derived from the metadata.
The supported formats of the table file are CMOR2/ASCII and CMOR3/json.
The supported format of the table file is CMOR3/json.
These tables are typically made available from MIP web sites.
A comma separated list of "key=value" pairs with optional parameters can be specified.
These optional parameters can be set to overwrite all entries of a parameter table from the command line.
These optional parameters can be set to overwrite all entries of a parameter
table defined by the {\texttt __info} command line parameter.
Entries with two leading underscores are used for cdo/cmor internal purposes.
CMOR itself uses entries with one leading underscore internally. The remaining k-v pairs are
used as attributes. Unknown (to CMOR) keys are simply copied as global attributes.
......@@ -37,11 +38,37 @@ used as attributes. Unknown (to CMOR) keys are simply copied as global attribute
@Item = table
STRING Name of the MIP table as specified from PCMDI
@Item = __var
STRING Comma separated list of variables
STRING Comma separated list of variables. Default is to process all variables.
@Item = __info
STRING Configuration file name
@Item = __grid_table
STRING Name of the MIP grid definition table as specified from PCMDI
@Item = __rename_<axis name>
STRING Rename z-axis to match the grid_table
@Item = __inpath
STRING All remaining parameters are for
\href{http://cmor.llnl.gov/mydoc_cmor3_api/}{\texttt cmor_setup()}.
@Item = __chunk
STRING netcdf_file_action parameter of cmor_setup()
@Item = __set_verbosity
STRING
@Item = __exit_control
STRING
@Item = __logfile
STRING
@Item = __create_subdirectories
INTEGER
@EndParameter
@BeginExample
Process file with CMOR. In this case a grid mapping is used. The file
{\texttt cmor.rc} contains metadata CMOR expects for
\href{http://cmor.llnl.gov/mydoc_cmor3_api/#cmordatasetjson}
{\texttt cmor_dataset_json()}.
@BeginVerbatim
cdo cmor,Tables/CMIP6_day.json,__grid_table=Tables/CMIP6_grids.json,__info=cmor.rc \
CNRM-CERFACS_rllc.nc
@EndVerbatim
@EndExample
......@@ -5041,19 +5041,29 @@ static const char *CMORHelp[] = {
" Each output file contains a single output variable with there coordinates and metadata.",
" Much of the metadata written to the output files is defined in the table file.",
" The name of the output files are derived from the metadata.",
" The supported formats of the table file are CMOR2/ASCII and CMOR3/json.",
" The supported format of the table file is CMOR3/json.",
" These tables are typically made available from MIP web sites.",
" ",
" A comma separated list of \"key=value\" pairs with optional parameters can be specified.",
" These optional parameters can be set to overwrite all entries of a parameter table from the command line.",
" These optional parameters can be set to overwrite all entries of a parameter",
" table defined by the {\\texttt __info} command line parameter.",
" Entries with two leading underscores are used for cdo/cmor internal purposes.",
" CMOR itself uses entries with one leading underscore internally. The remaining k-v pairs are",
" used as attributes. Unknown (to CMOR) keys are simply copied as global attributes.",
"",
"PARAMETER",
" table STRING Name of the MIP table as specified from PCMDI",
" __var STRING Comma separated list of variables",
" __info STRING Configuration file name",
" table STRING Name of the MIP table as specified from PCMDI",
" __var STRING Comma separated list of variables. Default is to process all variables.",
" __info STRING Configuration file name",
" __grid_table STRING Name of the MIP grid definition table as specified from PCMDI",
" __rename_<axis name> STRING Rename z-axis to match the grid_table",
" __inpath STRING All remaining parameters are for",
" \href{http://cmor.llnl.gov/mydoc_cmor3_api/}{\texttt cmor_setup()}.",
" __chunk STRING netcdf_file_action parameter of cmor_setup()",
" __set_verbosity STRING",
" __exit_control STRING",
" __logfile STRING",
" __create_subdirectories INTEGER",
NULL
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment