How to use this template:
* Once you are on this page, log in (if you have not logged in before, you will need to register)
* Select "Edit" in the upper right corner
* Click on the "Wiki Markup" tab
* Select and then copy all of the wiki markup text in the main text box that appears below these instructions
* After copying, click on the "Cancel" tab so that you do not make any changes to this page
* Select "Models" in the dark green navigation bar at the top of this page
* Once the "Models" page comes up, go to the bottom and select "Add child page"
* Type the name of the model you are adding in the title bar at top of the new page
* Paste the template text into the main text box of the new page
* Edit the template text, taking care to preserve the headers present in the template
When viewed using the Wiki Markup tab, headers start and end with bracketed text that defines the color scheme, for example, Model name
If the write up for a model runs long, and takes up many screens, breaking it up into several separate pages can make it easier or users to read.
Brief introduction at the start, comprising one or several sentences, giving a short description of the model and its role in the Collaboratorium.
Overview
Model name Insert model name here (followed by acronym)
Brief description Brief description of model’s purpose and how it works at a high level
Model developer(s) Self explanatory
Institutional affiliation of developer(s) Self explanatory
Date created Self explanatory
Date of most recent revision Self explanatory
Model accessibility Phrase which describes which, if any, versions of this model are available to researchers outside of the model development team
Documentation Include link to any on-line documentation or papers that provide documentation.
Key publications Include key papers, with preference to Web accessible materials.
Model attributes
Model type For example, General circulation model (GCM) or Integrated assessment model (IAM) or other (followed by acronym)
Geographic scope Extent of geographic coverage
Geographic resolution Level of geographic disaggregation
Start date Earliest date when model runs can begin
End date Latest date when model runs can end
Time step Number of years between discrete
Data sources List of the key data sources used in the model, with links if possible
Approach for addressing risk/uncertainty Brief phrase describing how model deals with risk/uncertainty e.g. stochastic modeling approach, estimations of uncertainty based on variances in input values for discrete variables etc.
Key modules and linkages between them
Note: Include only if multiple modules, and if so, include next major header, “Variables and key assumptions,” for each
Model structure Describe in words or insert model diagram if one is available. Graphics files, such as jpeg's and gif's, can be inserted by using the picture icon in the upper left corner of the editing screen (under the tab labeled "Wiki Markup"). By default, pictures are initially inserted at the bottom of the wiki page, but they can subsequently be moved by cutting and pasting the file name and surrounding formatting characters.
Variables and key assumptions
Input variables
Key assumptions Explain in words and include equations if available
Output variables
Note: As noted above, if there are multiple modules, include section like this for each, with module name at start of header, followed by a colon.
Return to Models