Overview
, is structured as follows
cmip6/citations/citations.xls
cmip6/responsible_parties/responsible parties.xlsx
cmip6/models/initialization_from_CMIP5.json
model_publication.json
model_A/realms*.xlsx
coupling.xlsx
pdf/realms*.pdf
model_B/realms*.xlsx
coupling.xlsx
pdf/realms*.pdf
cmip6/simulations/model_A/ensembles/ensembles.xlsx
conformance/stage_1.xlsx
stage_2/stage2*.xlsx
model_B/ensembles/ensembles.xlsx
conformance/stage_1.xlsx
stage_2/stage2*.xlsx
cmip6/machines/machines.xls
machine_publication.json
cmip6/performance/performance*.xlsx
performance_publication.json
cmip5/models
Each folder (in bold typeface) contains the resources needed to document a particular aspect of the CMIP6 process. For example, the folder
cmip6/performance/
will contain spreadsheets for documenting the performance of CMIP6 simulations.
Citations
The cmip6/citations folder contains a single spreadsheet for collecting the citations, i.e. academic references to published work relating to CMIP6. The file name of the spreadsheet contains the CMIP6 institution_id (in lower case), for example:
cmip6/citations/cmip6_miroc_citations.xlsx
The citations are cross-referenced by the model descriptions.
Responsible parties
The cmip6/responsible_parties folder contains a single spreadsheet for collecting information about the people and organizations involved with the CMIP6 project. The file name of the spreadsheet contains the CMIP6 institution_id (in lower case), for example:
cmip6/responsible_parties/cmip6_cccr-iitm_reposnsible_parties.xlsx
The responsible parties are cross-referenced by the model descriptions.
Models
The cmip6/models folder contains spreadsheet, PDF and configuration files for collecting information about the CMIP6 models. There is a folder for each model, named by its CMIP6 source_id (in lower case); a configuration file to specify any initialization from CMIP5 models; and a configuration file to control the publication of model documentation. For example:
cmip6/models/initialization_from_cmip5.json cmip6/models/model_publication.json cmip6/models/gfdl-am4/ cmip6/models/gfdl-cm4/ cmip6/models/gfdl-esm2m/ cmip6/models/gfdl-esm4/
The folder for each model contains spreadsheets for collecting information about each realm (e.g. ocean, atmosphere, etc.), including the coupling between realms, as well as sub-folders for other resources, such as the pdf folder containing PDF files offering an alternative view of the model documentation. All file names contain the CMIP6 institution_id and the CMIP6 source_id (both in lower case), for example:
cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_aerosol.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_atmoschem.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_atmos.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_landice.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_land.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_ocean.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_ocnbgchem.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_seaice.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_toplevel.xlsx cmip6/models/gfdl-cm4/cmip6_noaa-gfdl_gfdl-cm4_coupling.xlsx cmip6/models/gfdl-cm4/pdf/
Simulations
The cmip6/simulations folder contains sub-folders for documenting the simulations performed by the models. It contains a sub-folder for each model, named by its CMIP6 source_id (in lower case), for example:
cmip6/simulations/bcc-csm2-hr/ cmip6/simulations/bcc-csm2-mr/ cmip6/simulations/bcc-esm1/
Each model folder contains an ensembles sub-folder for collecting information on ensembles; a conformance sub-folder for collecting conformance to experimental requirements; and a performance sub-folder for collecting model computational performance, for example:
cmip6/simulations/bcc-esm1/conformances/ cmip6/simulations/bcc-esm1/ensembles/ cmip6/simulations/bcc-esm1/performance/
Conformances
The cmip6/conformance folder initially contains a spreadsheet for describing the default conformances for a particular model The file name of which will contain the CMIP6 institution_id and the CMIP6 source_id (both in lower case), for example:
cmip6/simulations/bcc-esm1/conformances/cmip6_bcc-esm1.default.xlsx
There is also a stage_2 sub-folder that will contain the spreadheets required for the second phase of conformance collection. These spreadsheets will be used to tailor the default conformances to the experiments in each MIP, and their file names will contain the CMIP6 institution_id, the CMIP6 source_id and CMIP6 activity_id (all in lower case), for example:
cmip6/simulations/bcc-esm1/conformances/stage_2/cmip6_bcc-esm1.deck.xlsx cmip6/simulations/bcc-esm1/conformances/stage_2/cmip6_bcc-esm1.fafmip.xlsx
Note that the stage 2 spreadsheets are generated on request after the default conformances spreadsheet has been completed.
Machines
The cmip6/machines folder contains a spreadsheet for collecting information about the computers used to run simulations. The file name of the spreadsheet contains the CMIP6 institution_id (in lower case) for example:
cmip6/machines/cmip6_ec-earth-consortium_machines.xlsx
Performance
The cmip6/performance folder contains spreadsheets for collecting information about the performance of particular models running on particular machines. The file name of the spreadsheet contains the CMIP6 institution_id (in lower case) and the name of a particular machine, the latter as defined in the machines spreadsheet found in the cmip6/machines folder. For example:
cmip6/machines/cmip6_ipsl_curie_performance.xlsx
cmip5/models
The cmip5/models folder contains machine-readable descriptions of the models previously documented for the CMIP5 project and are not required for documenting CMIP6. Human-readable versions of these descriptions are avaible via the ES-DOC viewer, however, which could prove useful when documenting CMIP6 models.