CMIP6 model realm descriptions are documented and published using spreadsheets; each spreadsheet documents one realm of one model. Below are instructions for documenting a model realm using this spreadsheet:
1. Open the spreadsheet using Microsoft Excel, LibreOffice, or another spreadsheet editor.
The spreadsheet is composed of a number of sheets. The first page contains the table of contents and the institute, model, and realm, which is also duplicated in the filename. Please verify that the model and realm that you’re intending to document.
2. Examine the table of contents and document structure.
The spreadsheet is composed of a number of sheets, or pages. The first page contains the Table of Contents and the subsequent pages contain the model properties to document. Each page of the spreadsheet documents one sub-topic which is identified by its sheet name and in the table of contents. For example, if the spreadsheet has 10 sub-topics, there will be 11 sheets in the document (the first being the Table of Contents)
3. Open the first sub-topic page.
Each sub-topic page contains a collection of related questions about the model’s handling of the realm in question. The questions may be further grouped into detail groups or hang directly off the sub-topic. Each question has a number that identifies it within the document. For example, question 5.1.2 is the second question in the sub-topic #5, and question 5.2.2 is the second question of the first detail group of sub-topic #5. However, the organization and order of the questions are unimportant in that each question may be answered without regard to other questions.
4. Examine the first question.
The structure and layout of the question give details on the question and the type of expected response.
- The question number identifies the question order within the overall document
- Questions that are required to answer have an asterisk (*) following the number; question numbers without an asterisk are optional.
- The cell to the right of the question number identifies the question name, and the cell below that gives more detail on the information requested.
- The gray cell below the question description is the answer cell, the location to record your answer. Depending on the type of requested response, the answer cell may be a drop-down selection with choices or a blank cell.
- The cell below the question number indicates the type of requested response
- INTEGER. Enter an integer into the answer cell.
- BOOLEAN. Select “TRUE” or “FALSE” in answer cell drop-down choice.
- FLOAT. Enter a floating point number in the answer cell.
- STRING. Enter text in the answer cell
- Special case #1: If a note below the question description reads “NOTE: Please enter a comma separated list”, the answer may take the form of multiple words separated by commas; e.g. “cat,dog,bear”
- Special case #2: If the answer cell is tall (as if to accomodate a longer answer) and a note below the question reads “NOTE: Double click to expand if text is too long for cell”, a longer than usual, multiple-sentence answer is requested.
- ENUM. The answer cell contains a list of possible choices. Select one of the answers in the drop-down choices.
- Open enumerated variation: If one of the choices is “Other: document to the right”, you may enter a text response that’s not one of the choices. In this case, select the “Other: document to the right” option, and place your answer in the cell directly to the right of the answer cell.
- Open multiple-choice enumerated variation: If a note below the question description reads “NOTE: multiple entries are allowed, please insert a new row per entry”, you may select more than one answer. If you desire to give one answer, select one of the choices as usual. For a second (and more) answer, add a new row directly below the answer cell. Then try copying the answer cell into the new blank cell and then activating the drop-down. If it doesn’t work, just enter the enumerated text as desired.
5. Answer the question.
If there’s already an answer in the answer cell, verify that the answer is still correct.
If the question is optional, you may leave it blank.
If the question is required, determine the expected answer type and enter the answer in the answer cell, as described just above.
After entering your answer, you may see a Validation error if the type of your response doesn’t match the expected response (e.g. requested response is a Integer and you enter a string).
6. Continue to the next question.
7. When all required questions on the Sub-topic sheet are complete, go to the next Sub-topic sheet.
Congratulations, you have documented a model realm! Please refer back to the Liaison checklist for next steps.