Help template: Difference between revisions
From CSDMS
Created page with "=Erode= ==Model Introduction== <span style="color:gray">~3lines that describe the module</span> ==Extended model introduction== <span style="color:gray">Extended introduction t..." |
m Text replacement - "http://csdms.colorado.edu/wiki/" to "https://csdms.colorado.edu/wiki/" |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
= | ={{PAGENAME}}= | ||
<span style="color:gray">''The name should be the same as the name of the website</span> | |||
==Model Introduction== | ==Model Introduction== | ||
| Line 30: | Line 31: | ||
|- | |- | ||
|} | |} | ||
==Coupling parameters== | |||
===Uses ports=== | |||
<span style="color:gray">This will be something that the CSDMS facility will add</span> | |||
===Provides ports=== | |||
<span style="color:gray">This will be something that the CSDMS facility will add</span> | |||
==Main equations== | ==Main equations== | ||
| Line 42: | Line 50: | ||
==Examples== | ==Examples== | ||
<span style="color:gray">An example run with input parameters as well as a figure / movie of the output</span> | <span style="color:gray">An example run with input parameters as well as a figure / movie of the output</span> | ||
<span style="color:gray">Follow the next steps to include images / movies of simulations:</span> | |||
* Upload file: https://csdms.colorado.edu/wiki/Special:Upload | |||
* Create link to the file on your page: <nowiki>[[Image:<file name>]]</nowiki>. | |||
<span style="color:gray">See also: [[Help:Images]] or [[Help:Movies]]</span> | |||
==Developer(s)== | ==Developer(s)== | ||
Latest revision as of 17:06, 19 February 2018
Help template
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: https://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....
