Form:Module questionnaire: Difference between revisions

From CSDMS
New page: ===Model Questionnaire=== Please take some time to complete the form below. Make sure that after you complete the questionnaire you submit the form by pressing the submission button at th...
 
No edit summary
 
(287 intermediate revisions by the same user not shown)
Line 1: Line 1:
===Model Questionnaire===
<noinclude>
===Start Module questionnaire===
This questionnaire is for those who are willing to contribute their model, tools or algorithms, either presently or in the near future. Please take some time (on average 30 minutes) to complete the form.
__NOCACHE__
A special model page for your model is created instantly. On your model page you'll be able to share the model code, provide user information, share bug fixes and give other users the possibility to submit model questions / bug reports.


Please take some time to complete the form below. Make sure that after you complete the questionnaire you submit the form by pressing the submission button at the bottom of this page.
Ready to '''submit your model source code''' to the CSDMS repository? Once you have submitted this questionnaire, Zip or tar the source code and mail it to: [mailto:CSDMSsupport@colorado.edu CSDMSsupport@colorado.edu], or let us know when the files are to large, we can open a ftp site for you so you can upload your model.
Thank you for your time in advance!
 
{{#ifexist:User:{{CURRENTUSER}}||{{Login warning}}}}
 
{{#forminput:form=Module questionnaire||Name module||placeholder=Enter model name ||namespace=Model}}
 
 
(''Please keep the module name as short as possible'')
 
'''Thank you for your time in advance!'''
 
</noinclude><includeonly>
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
 
===Module questionnaire===
__NOCACHE__
''Make sure that after you complete the questionnaire you submit the form by pressing the '''submission button on the last tab'''.'' A special module page for your module will be created instantly on submission.
 
__NOTOC__
{{Summary_header}}
 
{{{for template|Model identity|label=Module type}}}
{| class="formtable"
<!--! valign=top style="width:250px;" | Module name:
| {{BASEPAGENAME}} -->
|-
! Also known as:
| {{{field|Model also known as|input type=textarea|cols=27|rows=1}}}
|-
! Indicate framework if the model<br>is part of a larger framework:
| | {{{field|ModelFramework|input type=combobox|values from property=ModelFramework}}}
|-
! Module type:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Model type|mandatory|show on select=Modular=>modular-yes}}}
|-
! Note on status model:
| {{{field|Note on status model|input type=textarea|placeholder=Leave open unless e.g. model repositories have been merged|cols=80|rows=2}}}
|-
! Date note status model:
| {{{field|Date note status model|input type= datepicker|placeholder=Leave open unless you included a 'Note on status model' above}}}
|}
{{{end template}}}
<div id=modular-yes>
{{{for template|Start models incorporated}}}
{|
|}
{{{end template}}}
{{{for template|Models incorporated|label=Incorporated models|multiple}}}
{|
! valign=top style="width:250px;" | Model incorporates the following modules or components:
| {{{field|Incorporated modules|input type=combobox|values from namespace=Model}}}
|}
{{{end template}}}
{{{for template|End a table}}}
{|
|}
{{{end template}}}
</div>
{{{for template|Model identity2|label=Module identity}}}
{| class="formtable"
! valign=top style="width:250px;" | Module domain:
| colspan=2 align=top width="510px"| {{{field|ModelDomain}}}
|-
! valign=top style="width:250px;" | Spatial dimensions:<br><i>(More options possible)</i>
| align=top width="60px"| {{{field|Spatial dimensions}}}
| align=top width="450px"|For example:
* 1D:    profiles
* 1.5D: 2D projections extracted from 1D profiles
* 2D:    a DEM grid with one value of z for every x-y location
* 3D:    multiple z values possible for every x-y location
|-
!align=top | Spatial extent:<br><i>(More options possible)</i>
|align=top | {{{field|Spatialscale}}}
|align=top | For Example:
* The world
* Continental (order 1,000 km)
* Regional-Scale (order 100 km)
* Landscape-Scale (order 10 km)
* Watershed-Scale (order 1 km)
* Reach-Scale (order 100m)
* Patch-Scale (order 1-10m)
* Grain-Scale (order 0.00001 to 1m)
* Point-Based
|}
{| class="formtable"
! valign=top style="width:250px;" | One-line module description:<div style="float:right;"><font color="red">*</font></div>
| {{{field|One-line model description|mandatory|input type=textarea|cols=100|rows=1}}}
|-
! Extended module description:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Extended model description|mandatory|input type=textarea|cols=100}}}
|}
{{{end template}}}
{{{for template|Start model keyword table}}}
{|
|}
{{{end template}}}
{{{for template|Model keywords|label=Model Keywords|multiple}}}
{| class="formtable"
! valign=top style="width:220px;" | Keywords:
| {{{field|Model keywords|input type=combobox|values from property=Model keywords}}}
|}
{{{end template}}}
{{{for template|End a table}}}
{|
|}
{{{end template}}}
 
{{Contact_information_header}}
 
{{{for template|Modeler information|label=Contact details modeler}}}
{| class="formtable"
! valign=top style="width:250px;" |First name:<div style="float:right;"><font color="red">*</font></div>
| {{{field|First name|mandatory|input type=combobox|values from property=First name member}}}
|-
! Last name:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Last name|mandatory|input type=combobox|values from property=Last name member}}}
|-
! Type of contact:
| {{{field|Type of contact}}}
|-
! Institute / Organization:
| {{{field|Institute / Organization|input type=textarea|cols=50|rows=1}}}
|-
! Postal address 1:
| {{{field|Postal address 1|input type=textarea|cols=50|rows=1}}}
|-
! Postal address 2:
| {{{field|Postal address 2|input type=textarea|cols=50|rows=1}}}
|-
! Town / City:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Town / City|mandatory|input type=combobox|values from property=City member}}}
|-
! Postal code:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Postal code|mandatory|input type=textarea|cols=50|rows=1}}}
|-
! Country:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Country|mandatory|default=United States|show on select=United States=>USA}}}
|}
<div id="USA">
{|class="formtable"
! valign=top style="width:250px;" | State:
| {{{field|State}}}
|}
</div>
 
{|class="formtable"
! valign=top style="width:250px;" | Email address:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Email address|mandatory|input type=textarea|cols=50|rows=1}}}
|-
! Phone:
| {{{field|Phone|input type=textarea|cols=50|rows=1}}}
|-
! Fax:
| {{{field|Fax|input type=textarea|cols=50|rows=1}}}
|}
{{{end template}}}
 
{{{for template|Additional modeler information|label=Contact details additional modeler|multiple}}}
{| class="formtable"
! valign=top style="width:220px;" | First name:
| {{{field|Additional first name|input type=combobox|values from property=First name member}}}
|-
! Last name:
| {{{field|Additional last name|input type=combobox|values from property=Last name member}}}
|-
! Type of contact:
| {{{field|Additional type of contact}}}
|-
! Institute / Organization:
| {{{field|Additional institute / Organization|input type=textarea|cols=50|rows=1}}}
|-
! Postal address 1:
| {{{field|Additional postal address 1|input type=textarea|cols=50|rows=1}}}
|-
! Postal address 2:
| {{{field|Additional postal address 2|input type=textarea|cols=50|rows=1}}}
|-
! Town / City:
| {{{field|Additional town / City|input type=combobox|values from property=City member}}}
|-
! Postal code:
| {{{field|Additional postal code|input type=textarea|cols=50|rows=1}}}
|-
! Country:
| {{{field|Additional country|default=United States|show on select=United States=>USA-additional}}}
|}
<div id="USA-additional">
{|class="formtable"
! valign=top style="width:220px;" | State:
| {{{field|Additional state}}}
|}
</div>
{|class="formtable"
! valign=top style="width:220px;" | Email address:
| {{{field|Additional email address|input type=textarea|cols=50|rows=1}}}
|-
! Phone:
| {{{field|Additional phone|input type=textarea|cols=50|rows=1}}}
|-
! Fax:
| {{{field|Additional fax|input type=textarea|cols=50|rows=1}}}
|}
{{{end template}}}
 
{{Technical_specs_header}}
 
{{{for template|Model technical information|label=Technical information}}}
{| class="formtable"
! valign=top style="width:250px;" | Supported platforms:<br><i>(More options possible)</i>
| {{{field|Supported platforms}}}
|
|-
! Other platform:
| {{{field|Other platform|input type=textarea|cols=50|rows=1}}}
|
|-
! Programming language:
| {{{field|Programming language}}}
|
|-
! Other programming language:
| {{{field|Other program language|input type=textarea|cols=50|rows=1}}}
|
|-
! Code optimized for:<br><i>(More options possible)</i>
| {{{field|Code optimized|show on select=Multiple Processors=>code_optimized_yes}}}
|
|-
|}
<div id="code_optimized_yes">
{| class="formtable"
! valign=top style="width:250px;" | How is the use of multiple processors implemented:
|width="200"| {{{field|Multiple processors implemented}}}
|width="200"| Nr. of distributed processors:<br>Nr. of shared processors:
|width="100"| {{{field|Nr of distributed processors}}}<br>{{{field|Nr of shared processors}}}
|}
</div>
{| class="formtable"
! valign=top style="width:250px;" | Start year development:
| {{{field|Start year development}}}
|
|-
! Does module development still take place?:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Does model development still take place?|mandatory|input type=radiobutton|default=No|show on select=No=>development_end;Yes=>development_still}}}
|
|-
|}
<div id="development_end">
{| class="formtable"
! valign=top style="width:250px;" | Provide end year module development:
| {{{field|End year development}}}
|
|}
</div>
<div id="development_still">
</div>
{| class="formtable"
! valign=top style="width:250px;" | Status development code:<div style="float:right;"><font color="red">*</font></div>
| {{{field|DevelopmentCode|input type=dropbox|mandatory}}}
|
|-
! valign=top style="width:250px;" | Year when 'Status development code' was indicated:<div style="float:right;"><font color="red">*</font></div>
| {{{field|DevelopmentCodeYearChecked|input type=dropbox|mandatory}}}
|
|-
! valign=top style="width:250px;" | Module availability:
| {{{field|Model availability}}}
|
|-
! Repository where source code can be found:
| {{{field|Source code availability|show on select=Through web repository=>webaddress;Through CSDMS repository=>no_webaddress;}}}
|
|}
<div id="webaddress">
{| class="formtable"
! valign=top style="width:250px;" | Source code downloadable from website:
| {{{field|Source web address|input type=textarea|cols=50|rows=1}}}
|
|}
</div>
<div id="no_webaddress">
{| class="formtable"
! valign=top style="width:250px;" | Source code downloadable from website:
| {{{field|Source csdms web address|input type=textarea|cols=50|rows=1}}}
|
|}
</div>
{| class="formtable"
! valign=top style="width:250px;" | Program license type:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Program license type|mandatory|show on select=Other=>other_license}}}
|
|}
<div id="other_license">
{| class="formtable"
! valign=top style="width:250px;" |Other license:
| {{{field|Program license type other|input type=textarea|cols=50|rows=1}}}
|
|}
</div>
{| class="formtable"
! valign=top style="width:250px;" | Memory requirements:
| {{{field|Memory requirements|input type=textarea|cols=50|rows=1}}}
|
|-
! Typical run time:
| {{{field|Typical run time|input type=textarea|cols=50|rows=1}}}
|
|}
{{{end template}}}
 
{{In-Output_header}}
 
{{{for template|Input - Output description|label=Input / Output description}}}
{| class="formtable"
! valign=top style="width:250px;" | Describe input parameters:
| {{{field|Describe input parameters|input type=textarea|cols=50|rows=1}}}
|-
! Input format:
| {{{field|Input format}}}
|-
! Other input format:
| {{{field|Other input format|input type=textarea|cols=50|rows=1}}}
|-
! Describe output parameters:
| {{{field|Describe output parameters|input type=textarea|cols=50|rows=1}}}
|-
! Output format:
| {{{field|Output format}}}
|-
! Other output format:
| {{{field|Other output format|input type=textarea|cols=50|rows=1}}}
|-
! Pre-processing software needed?:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Pre-processing software needed?|mandatory|input type=radiobutton|default=No|show on select=Yes=>show_preprocess;No=>hide_preprocess}}}
|}
<div id="show_preprocess">
{| class="formtable"
! valign=top style="width:250px;" | Describe pre-processing software:
| {{{field|Describe pre-processing software|input type=textarea|cols=100}}}
|}
</div>
<div id="hide_preprocess">
</div>
{| class="formtable"
! valign=top style="width:250px;" | Post-processing software needed?:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Post-processing software needed?|mandatory|input type=radiobutton|default=No|show on select=Yes=>show_postprocess}}}
|}
<div id="show_postprocess">
{| class="formtable"
! valign=top style="width:250px;" | Describe post-processing software:
| {{{field|Describe post-processing software|input type=textarea|cols=100}}}
|}
</div>
{| class="formtable"
! valign=top style="width:250px;" | Visualization software needed?:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Visualization software needed?|mandatory|input type=radiobutton|default=No|show on select=Yes=>show_visualizationsoftware}}}
|}
<div id="show_visualizationsoftware">
{| class="formtable"
! valign=top style="width:250px;" | Select visualization software:
| {{{field|If above answer is yes}}}
|-
! Other visualization software:
| {{{field|Other visualization software}}}
|-
|}
</div>
{{{end template}}}
 
{{Process_header}}
 
{{{for template|Process description model|label=Process representation}}}
{| class="formtable"
! valign=top style="width:250px;" | Describe processes represented by the module:
| {{{field|Describe processes represented by the model|input type=textarea|cols=100}}}
|-
! Describe key physical parameters and equations:
| {{{field|Describe key physical parameters and equations|input type=textarea|cols=100}}}
|-
! Describe length scale and resolution constraints:
| {{{field|Describe length scale and resolution constraints|input type=textarea|cols=100}}}
|-
! Describe time scale and resolution constraints:
| {{{field|Describe time scale and resolution constraints|input type=textarea|cols=100}}}
|-
! Describe any numerical limitations and issues:
| {{{field|Describe any numerical limitations and issues|input type=textarea|cols=100}}}
|}
{{{end template}}}
 
{{Testing_header}}
 
{{{for template|Model testing|label=Module testing}}}
{| class="formtable"
! valign=top style="width:250px;" | Describe available calibration data sets:
| {{{field|Describe available calibration data sets|input type=textarea|}}}
|-
! Upload calibration data sets if available (<i>Multiple files possible</i>):
| {{{field|Model calibration data|uploadable|size=45}}}
|-
! Describe available test data sets:
| {{{field|Describe available test data sets|input type=textarea|}}}
|-
! Upload test data sets if available (<i>Multiple files possible</i>):
| {{{field|Model test data|uploadable|size=45}}}
|-
! Describe ideal data for testing:
| {{{field|Describe ideal data for testing|input type=textarea|}}}
|}
{{{end template}}}
 
{{Other_header}}
 
{{{for template|Users groups model|label=Users groups}}}
{| class="formtable"
! valign=top style="width:250px;" | Do you have current or future plans for collaborating with other researchers?:
| {{{field|Do you have current or future plans for collaborating with other researchers?|input type=textarea|cols=100}}}
|}
{{{end template}}}
 
{{{for template|Additional users groups model|label=Additional users groups|multiple}}}
{| class="formtable"
! valign=top style="width:250px;" | Do you have current or future plans for collaborating with other researchers?:
| {{{field|Do you have current or future plans for collaborating with other researchers?|input type=textarea|cols=100}}}
|}
{{{end template}}}
 
{{{for template|Documentation model|label=Documentation}}}
{| class="formtable"
! valign=top style="width:250px;" | Is there a manual available?:<div style="float:right;"><font color="red">*</font></div>
| {{{field|Manual model available|mandatory|input type=radiobutton|default=No|show on select=Yes=>uploadmanual}}}
|}
<div id="uploadmanual">
{| class="formtable"
! valign=top style="width:250px;" | Upload manual:
| {{{field|Model manual|uploadable|size=35}}}
|}
</div>
{| class="formtable"
! Module website if any:
| {{{field|Model website if any|input type=textarea|cols=100|rows=1}}}
|-
! valign=top style="width:250px;" | Module forum / discussion board:
| {{{field|Model forum|input type=textarea|cols=100}}}
|}
{{{end template}}}
 
{{{for template|Additional comments model|label=Additional comments}}}
{| class="formtable"
! valign=top style="width:250px;" | Comments:
| {{{field|Comments|input type=textarea|cols=100}}}
|}
{{{end template}}}
 
{{ModelQuestionnaire_Component_header}}
 
{{{for template|CSDMS staff part|label=Component structure}}}
''This part will be filled out by a CSDMS-IF member''
{| class="formtable"
! valign=top style="width:250px;" | OpenMI compliant:
| {{{field|OpenMI compliant|input type=radiobutton|default=Not yet|restricted}}}
|-
! BMI compliant:
| {{{field|IRF interface|input type=radiobutton|default=Not yet|restricted}}}
|-
! Is model available in the CSDMS model Tool (WMT)?:
| {{{field|CMT component|input type=radiobutton|default=Not yet|restricted}}}
|-
! Is model available in PyMT?:
| {{{field|PyMT component|input type=radiobutton|default=Not yet|restricted}}}
|-
! Is this a Data Component?:
| {{{field|DataComponent|input type=radiobutton|default=No}}}
|-
| {{{field|CodeReviewed|mandatory|default=0|hidden}}}
|-
|}
{{{end template}}}
 
{{{for template|DOI information|label=DOI information|multiple}}}
{| class="formtable"
! valign=top style="width:220px;" |  DOI name model:
| {{{field|DOI model|restricted|input type=textarea|cols=50|rows=1}}}
|-
! For model version:
| {{{field|DOI assigned to model version|restricted|input type=textarea|cols=50|rows=1}}}
|-
! Year version submitted:
| {{{field|DOI-year assigned to model version|input type=textarea|cols=50|rows=1|restricted}}}
|-
! Link to doi file:
| {{{field|DOI-filelink|restricted|input type=textarea|cols=50|rows=1}}}
|}
{{{end template}}}
 
{{{for template|Start coupled table}}}
{|
|}
{{{end template}}}
 
{{{for template|CSDMS coupled models|label=Can couple with|multiple}}}
{| class="formtable"
! valign=top style="width:220px;" | Can be coupled with:
| {{{field|CanCoupleWith|input type=combobox|values from namespace=Model|restricted}}}
|}
{{{end template}}}
 
{{{for template|End a table}}}
{|
|}
{{{end template}}}
 
{{{for template|End headertab}}}
{|
|}
{{{end template}}}
<font color="red">*</font> ''Required fields''<br>
<font color="red">Notice</font>: If your press the save button below and nothing happens, scroll through all tabs as one or more of the previously filled out fields will indicate an error that needs to be addressed before you can save this form.<br>
 
{{{standard input|free text|hidden|preload=Template:After model questionnaire}}}
 
{{{standard input|watch}}}
 
{{{standard input|save|label=Submit questionnaire}}} {{{standard input|preview}}} {{{standard input|changes}}} {{{standard input|cancel}}}
<headertabs/>
</includeonly>
[[Category:Form]]

Latest revision as of 09:36, 6 June 2025

Start Module questionnaire

This questionnaire is for those who are willing to contribute their model, tools or algorithms, either presently or in the near future. Please take some time (on average 30 minutes) to complete the form.

A special model page for your model is created instantly. On your model page you'll be able to share the model code, provide user information, share bug fixes and give other users the possibility to submit model questions / bug reports.

Ready to submit your model source code to the CSDMS repository? Once you have submitted this questionnaire, Zip or tar the source code and mail it to: CSDMSsupport@colorado.edu, or let us know when the files are to large, we can open a ftp site for you so you can upload your model.

WARNING: You are not logged in. Please log in to continue. If not, all your added changes will be lost.


(Please keep the module name as short as possible)

Thank you for your time in advance!