Template:Boilerplate Model help: Difference between revisions
From CSDMS
mNo edit summary |
m Text replacement - "http://csdms.colorado.edu/wiki/" to "https://csdms.colorado.edu/wiki/" |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
1) Log in to the wiki | 1) Log in to the wiki | ||
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: | ||
* | * https://csdms.colorado.edu/wiki/Model help:<modelname> | ||
* Replace <modelname> with the name of a model | * Replace <modelname> with the name of a model | ||
3) Than follow the link "edit this page" | 3) Than follow the link "edit this page" | ||
| Line 19: | Line 19: | ||
<span class="remove_this_tag">Introduction to the module</span> | <span class="remove_this_tag">Introduction to the module</span> | ||
<div id=CMT_MODEL_PARAMETERS> | |||
==Model parameters== | ==Model parameters== | ||
= First tab header = | = First tab header = | ||
{|{{Prettytable}} class = " | {|{{Prettytable}} class = "unsortable" cellspacing="0" cellpadding="0" style="margin:0em 0em 0em 0;" | ||
|- | |- | ||
!Parameter! | !{{H13}}|Parameter | ||
|- | !{{H13}}|Description | ||
|width="20%"|<span class="remove_this_tag">First parameter</span> | !{{H13}}|Unit | ||
|width="60%"|<span class="remove_this_tag">Description parameter</span> | |-valign="top" | ||
|width="20%"|<span class="remove_this_tag">[Units]</span> | |width="20%" |<span class="remove_this_tag">First parameter</span> | ||
|width="60%" |<span class="remove_this_tag">Description parameter</span> | |||
|width="20%" |<span class="remove_this_tag">[Units]</span> | |||
|} | |} | ||
= Second tab header = | = Second tab header = | ||
{|{{Prettytable}} class = " | {|{{Prettytable}} class = "unsortable" cellspacing="0" cellpadding="0" style="margin:0em 0em 0em 0;" | ||
|- | |- | ||
!{{H13}}|Parameter | |||
!{{H13}}|Description | |||
!{{H13}}|Unit | |||
|-valign="top" | |||
|width="20%"|<span class="remove_this_tag">First parameter</span> | |width="20%"|<span class="remove_this_tag">First parameter</span> | ||
|width="60%"|<span class="remove_this_tag">Description parameter</span> | |width="60%"|<span class="remove_this_tag">Description parameter</span> | ||
| Line 42: | Line 47: | ||
= Etc. tab header = | = Etc. tab header = | ||
<headertabs/> | <headertabs/> | ||
</div> | |||
==Uses ports== | ==Uses ports== | ||
| Line 62: | Line 68: | ||
<span class="remove_this_tag">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 class="remove_this_tag">Upload file: | * <span class="remove_this_tag">Upload file: https://csdms.colorado.edu/wiki/Special:Upload</span> | ||
* <span class="remove_this_tag">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> | ||
Latest revision as of 17:18, 19 February 2018
Boilerplate Model help
~3lines that describe the module
Model introduction
Introduction to the module
Model 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
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:
- 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
Links
Any link, eg. to the model questionnaire, etc.
