Template:Boilerplate Model help: Difference between revisions

From CSDMS
m Protected "Template:Boilerplate Model help" ([edit=sysop] (indefinite) [move=sysop] (indefinite))
mNo edit summary
Line 43: Line 43:
|}
|}


==Coupling parameters==
==Uses ports==
===Uses ports===
<span style="color:gray">''This will be something that the CSDMS facility will add''</span>
<span style="color:gray">''This will be something that the CSDMS facility will add''</span>


===Provides ports===
==Provides ports==
<span style="color:gray">''This will be something that the CSDMS facility will add''</span>
<span style="color:gray">''This will be something that the CSDMS facility will add''</span>


==Main equations==
==Main equations==
<span style="color:gray">''A list of the key equations. HTML format is supported; latex format will be supported in the future''</span>
<span style="color:gray">''A list of the key equations. HTML format is supported; latex format will be supported in the future''</span>
===Numerical scheme===
<span style="color:gray">''Output variable''</span>


==Notes==
==Notes==
<span style="color:gray">''Any notes, comments, you want to share with the user''</span>  
<span style="color:gray">''Any notes, comments, you want to share with the user''</span>  
<span style="color:gray">''Numerical scheme</span>


==Examples==
==Examples==
Line 73: Line 72:
==References==
==References==
<span style="color:gray">''Key papers''</span>
<span style="color:gray">''Key papers''</span>


==Links==
==Links==

Revision as of 11:30, 28 October 2010

The CSDMS Help System
The CSDMS Help System

Boilerplate Model help

~3lines that describe the module

Model introduction

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

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

Notes

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

Numerical scheme


Examples

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

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

See also: Help:Images or Help:Movies

Developer(s)

Name of the module developer(s)

References

Key papers

Links

Any link, eg. to the model questionnaire, etc.