Template:Boilerplate Model help

How to create a new "Model help" page:

1. Log in to the wiki
2. Create a new page for each model, by using the following URL:
   1. http://csdms.colorado.edu/wiki/Model help:<modelname>
   2. Replace <modelname> with the name of a model from Gary
3. Than follow the link "edit this page"
   1. Now you will see preloaded text. Hit the button "Show Preview" at the bottom, below the edit window
   2. You will see gray text, replace the gray text and hit the button "save" and your help document is all done.

You can re-edit the page whenever you want.

The CSDMS Help System

Boilerplate Model help

Model Introduction

~3lines that describe the module

Extended model introduction

Extended introduction to the module

Model input parameters

input variable1	variable description1	variable units1
variable2	description2	units2

Model output parameters

output variable1	variable description1	variable units1
variable2	description2	units2

Coupling parameters

Uses ports

This will be something that the CSDMS facility will add

Provides ports

This will be something that the CSDMS facility will add

Main equations

A list of the key equations. HTML format is supported; latex format will be supported in the future

Numerical scheme

Output variable

Notes

Any notes, comments, you want to share with the user

Examples

An example run with input parameters as well as a figure / movie of the output

Follow the next steps to include images / movies of simulations:

• Upload file: http://csdms.colorado.edu/wiki/Special:Upload
• Create link to the file on your page: [[Image:<file name>]].

See also: Help:Images or Help:Movies

Developer(s)

Name of the module developer(s)

References

Key papers

External links

Any link, eg. to the model questionnaire, the e-book that is on the CSDMS web, Gary Parkers website....