Template:Boilerplate Model help
From CSDMS
Boilerplate Model help
The name should be the same as the name of the website
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....