Template:Boilerplate Model help: Difference between revisions

From CSDMS
← Older editNewer edit →
No edit summary
Line 4: Line 4:
2) Create a new page for each model, by using the following URL:
2) Create a new page for each model, by using the following URL:
   * http://csdms.colorado.edu/wiki/Model help:<modelname>
   * http://csdms.colorado.edu/wiki/Model help:<modelname>
   * Replace <modelname> with the name of a model from Gary
   * Replace <modelname> with the name of a model
3) Than follow the link "edit this page"
3) Than follow the link "edit this page"
   * Now you will see preloaded text. Hit the button "Show Preview" at the bottom, below the edit window
   * Now you will see preloaded text. Hit the button "Show Preview" at the bottom, below the edit window
   * You will see gray text; replace the gray text with help text and hit the button "save" and your help document is all done.
   * You will see gray text with tag: <span class="remove_this_tag">; Remove the gray text with supporting text and add your own, Hit the button "save" and your help document is all done.


You can re-edit the page whenever you want.
You can re-edit the page whenever you want.
Line 17: Line 17:


==Model introduction==
==Model introduction==
<span style="color:gray">''Introduction to the module''</span>
<span class="remove_this_tag">Introduction to the module</span>


==Model input parameters==
==Model input parameters==
{|
{|
|  <span style="color:gray">''input variable1''</span>
|  <span class="remove_this_tag">input variable1</span>
|  <span style="color:gray">''variable description1''</span>
|  <span class="remove_this_tag">variable description1</span>
|  <span style="color:gray">''variable units1''</span>
|  <span class="remove_this_tag">variable units1</span>
|-
|-
|  <span style="color:gray">''variable2''</span>
|  <span class="remove_this_tag">variable2</span>
|  <span style="color:gray">''description2''</span>
|  <span class="remove_this_tag">description2</span>
|  <span style="color:gray">''units2''</span>
|  <span class="remove_this_tag">units2</span>
|-
|-
|}
|}
Line 33: Line 33:
==Model output parameters==
==Model output parameters==
{|
{|
| <span style="color:gray">''output variable1''</span>
| <span class="remove_this_tag">output variable1</span>
| <span style="color:gray">''variable description1''</span>
| <span class="remove_this_tag">variable description1</span>
| <span style="color:gray">''variable units1''</span>
| <span class="remove_this_tag">variable units1</span>
|-
|-
| <span style="color:gray">''variable2''</span>
| <span class="remove_this_tag">variable2</span>
| <span style="color:gray">''description2''</span>
| <span class="remove_this_tag">description2</span>
| <span style="color:gray">''units2''</span>
| <span class="remove_this_tag">units2</span>
|-
|-
|}
|}


==Uses ports==
==Uses ports==
<span style="color:gray">''This will be something that the CSDMS facility will add''</span>
<span class="remove_this_tag">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 class="remove_this_tag">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 class="remove_this_tag">A list of the key equations. HTML format is supported; latex format will be supported in the future</span>


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


<span style="color:gray">''Numerical scheme</span>
<span class="remove_this_tag">Numerical scheme</span>




==Examples==
==Examples==
<span style="color:gray">''An example run with input parameters, BLD files, as well as a figure / movie of the output''</span>
<span class="remove_this_tag">An example run with input parameters, BLD files, 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 class="remove_this_tag">Follow the next steps to include images / movies of simulations:</span>
* <span style="color:gray">''Upload file: http://csdms.colorado.edu/wiki/Special:Upload</span>
* <span class="remove_this_tag">Upload file: http://csdms.colorado.edu/wiki/Special:Upload</span>
* <span style="color:gray">''Create link to the file on your page: <nowiki>[[Image:<file name>]]</nowiki>.</span>
* <span class="remove_this_tag">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 class="remove_this_tag">See also: [[Help:Images]] or [[Help:Movies]]</span>


==Developer(s)==
==Developer(s)==
<span style="color:gray">''Name of the module developer(s)''</span>
<span class="remove_this_tag">Name of the module developer(s)</span>


==References==
==References==
<span style="color:gray">''Key papers''</span>
<span class="remove_this_tag">Key papers</span>


==Links==
==Links==
<span style="color:gray">''Any link, eg. to the model questionnaire, etc.''</span>
<span class="remove_this_tag">Any link, eg. to the model questionnaire, etc.</span>


[[Category:Modules]] [[Category:Utility components]]
[[Category:Modules]] [[Category:Utility components]]

Revision as of 09:36, 29 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.

Retrieved from "https://csdms.colorado.edu/csdms_wiki/index.php?title=Template:Boilerplate_Model_help&oldid=16550"