Template:Boilerplate Model help: Difference between revisions
From CSDMS
Created page with "={{PAGENAME}}= <span style="color:gray">''The name should be the same as the name of the website</span> ==Model Introduction== <span style="color:gray">~3lines that describe the..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
={{PAGENAME}}= | ={{PAGENAME}}= | ||
<span style="color:gray">''The name should be the same as the name of the | <span style="color:gray">''The name should be the same as the name of the modelname that was used in the model questionnaire''</span> | ||
==Model Introduction== | ==Model Introduction== | ||
<span style="color:gray">~3lines that describe the module</span> | <span style="color:gray">''~3lines that describe the module''</span> | ||
==Extended model introduction== | ==Extended model introduction== | ||
<span style="color:gray">Extended introduction to the module</span> | <span style="color:gray">''Extended introduction to the module''</span> | ||
==Model input parameters== | ==Model input parameters== | ||
{| | {| | ||
|<span style="color:gray">input variable1</span> | | <span style="color:gray">''input variable1''</span> | ||
|<span style="color:gray">variable description1</span> | | <span style="color:gray">''variable description1''</span> | ||
|<span style="color:gray">variable units1</span> | | <span style="color:gray">''variable units1''</span> | ||
|- | |- | ||
|<span style="color:gray">variable2</span> | | <span style="color:gray">''variable2''</span> | ||
|<span style="color:gray">description2</span> | | <span style="color:gray">''description2''</span> | ||
|<span style="color:gray">units2</span> | | <span style="color:gray">''units2''</span> | ||
|- | |- | ||
|} | |} | ||
| Line 22: | Line 22: | ||
==Model output parameters== | ==Model output parameters== | ||
{| | {| | ||
|<span style="color:gray">output variable1</span> | | <span style="color:gray">''output variable1''</span> | ||
|<span style="color:gray">variable description1</span> | | <span style="color:gray">''variable description1''</span> | ||
|<span style="color:gray">variable units1</span> | | <span style="color:gray">''variable units1''</span> | ||
|- | |- | ||
|<span style="color:gray">variable2</span> | | <span style="color:gray">''variable2''</span> | ||
|<span style="color:gray">description2</span> | | <span style="color:gray">''description2''</span> | ||
|<span style="color:gray">units2</span> | | <span style="color:gray">''units2''</span> | ||
|- | |- | ||
|} | |} | ||
| Line 34: | Line 34: | ||
==Coupling parameters== | ==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=== | ===Numerical scheme=== | ||
<span style="color:gray"> | <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> | ||
==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> | <span style="color:gray">''Follow the next steps to include images / movies of simulations:''</span> | ||
* Upload file: http://csdms.colorado.edu/wiki/Special:Upload | * <span style="color:gray">''Upload file: http://csdms.colorado.edu/wiki/Special:Upload</span> | ||
* Create link to the file on your page: <nowiki>[[Image:<file name>]]</nowiki>. | * <span style="color:gray">''Create link to the file on your page: <nowiki>[[Image:<file name>]]</nowiki>.</span> | ||
<span style="color:gray">See also: [[Help:Images]] or [[Help:Movies]]</span> | <span style="color:gray">''See also: [[Help:Images]] or [[Help:Movies]]''</span> | ||
==Developer(s)== | ==Developer(s)== | ||
<span style="color:gray">Name of the module developer(s)</span> | <span style="color:gray">''Name of the module developer(s)''</span> | ||
==References== | ==References== | ||
<span style="color:gray">Key papers</span> | <span style="color:gray">''Key papers''</span> | ||
==External links== | ==External links== | ||
<span style="color:gray">Any link, eg. to the model questionnaire, the e-book that is on the CSDMS web, Gary Parkers website....</span> | <span style="color:gray">''Any link, eg. to the model questionnaire, the e-book that is on the CSDMS web, Gary Parkers website....''</span> | ||
Revision as of 20:38, 27 October 2010
Boilerplate Model help
The name should be the same as the name of the modelname that was used in the model questionnaire
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....
