SMS:Dynamic Model Interface Schema: Difference between revisions
From XMS Wiki
Jump to navigationJump to search
No edit summary |
|||
(16 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
__NOINDEX__ | |||
<center>'''Sorry the page you are looking for cannot be found.''' </center> | |||
[[File:Undercosntruction.png|center|200 px]] | |||
<center>'''We are working on creating a page for this topic.'''</center> | |||
[[SMS:SMS|Back to SMS]] | |||
<!-- | |||
{{TOCright}} | {{TOCright}} | ||
The dynamic model interface is available in SMS version 11.2 and later. It is primarily a tool for developers. The dynamic model interface provides a way to quickly generate an interface for a numeric model. | The dynamic model interface is available in SMS version 11.2 and later. It is primarily a tool for developers. The dynamic model interface provides a way to quickly generate an interface for a numeric model. | ||
Line 18: | Line 29: | ||
===Available Keywords=== | ===Available Keywords=== | ||
This is a list of available keywords. Additional keywords are defined with the various custom control widgets. Note that in changing from version 1 to version 2, all tags that were <code><custom_control_XXXX></code> were changed to <code><control_XXXX></code>. | This is a list of available keywords. Additional keywords are defined with the various custom control widgets. Note that in changing from version 1 to version 2, all tags that were <code><custom_control_XXXX></code> were changed to <code><control_XXXX></code>. | ||
--> | |||
<!-- template for this section | <!-- template for this section | ||
Line 39: | Line 50: | ||
--> | --> | ||
<!-- | |||
{|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | {|class="mw-collapsible mw-collapsed" style="border:1px solid #D0E0FF; margin-bottom:0.4em;" | ||
|- | |- | ||
Line 221: | Line 233: | ||
| example = | | example = | ||
}} | }} | ||
--> | |||
<!--obsolete | <!--obsolete | ||
{{XML entry | {{XML entry | ||
Line 231: | Line 244: | ||
| example = See the model example. | | example = See the model example. | ||
}}--> | }}--> | ||
<!-- | |||
{{XML entry | {{XML entry | ||
| name = card | | name = card | ||
Line 237: | Line 250: | ||
| version = 1 | | version = 1 | ||
| attributes = none | | attributes = none | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], anything beginning with " | | children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <export_location>|export_location]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], anything beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Attribute <use_parameter>|use_paramter]]. | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], file_def | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], file_def | ||
| example = <item text = "Formulation"> | | example = <item text = "Formulation"> | ||
Line 260: | Line 273: | ||
| info = Widget that displays text that is checked/unchecked. | | info = Widget that displays text that is checked/unchecked. | ||
| version = 1 | | version = 1 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Element <default>|default]], | | attributes = [[SMS:Dynamic Model Interface Schema#Element <default>|default]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_checked]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_unchecked]], [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]]. | ||
[[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_checked]], | |||
[[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_unchecked]], | |||
[[SMS:Dynamic Model Interface Schema#Element <text>|text]], | |||
[[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]]. | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | | children = [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]] | | used_by = [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]] | ||
| example = | | example = | ||
<check_box text = "Calculate Sediment Transport" | <check_box text = "Calculate Sediment Transport" | ||
Line 773: | Line 782: | ||
===Elements D-H=== | ===Elements D-H=== | ||
--> | |||
<!--obsolete | <!--obsolete | ||
{{XML entry | {{XML entry | ||
Line 787: | Line 797: | ||
</control_dataset> | </control_dataset> | ||
}}--> | }}--> | ||
<!-- | |||
{{XML entry | {{XML entry | ||
| name = declare_coverage | | name = declare_coverage | ||
Line 893: | Line 904: | ||
| attributes = none | | attributes = none | ||
| children = none | | children = none | ||
| used_by = input_file, [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]], anything beginning with " | | used_by = input_file, [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], [[SMS:Dynamic Model Interface Schema#Element <output_file>|output_file]], anything beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <takes>|takes]] | ||
| example = | | example = | ||
}} | }} | ||
Line 980: | Line 991: | ||
{{XML entry | {{XML entry | ||
| name = end_card | | name = end_card | ||
| info = Defines that the card end with a single iteration of the enclosing < | | info = Defines that the card end with a single iteration of the enclosing <process_> | ||
| version = 1 | | version = 1 | ||
| attributes = none | | attributes = none | ||
| children = none | | children = none | ||
| used_by = anything starting with | | used_by = anything starting with "process_" | ||
| example = | | example = | ||
}} | }} | ||
Line 1,099: | Line 1,110: | ||
| children = none | | children = none | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]], [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]], [[SMS:Dynamic Model Interface Schema#Element <export_each_coverage>|export_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <export_each_polygon>|export_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <export_each_arc>|export_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <export_each_point>|export_each_point]], | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <export_each_row>|export_each_row]], [[SMS:Dynamic Model Interface Schema#Element <export_column>|export_column]], [[SMS:Dynamic Model Interface Schema#Element <export_each_coverage>|export_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <export_each_polygon>|export_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <export_each_arc>|export_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <export_each_point>|export_each_point]], | ||
anything starting with | anything starting with "process_" | ||
| example = '''Example 1''' | | example = '''Example 1''' | ||
Line 1,180: | Line 1,191: | ||
}} | }} | ||
--> | --> | ||
<!-- | |||
{{XML entry | {{XML entry | ||
| name = group | | name = group | ||
Line 1,197: | Line 1,209: | ||
}} | }} | ||
--> | |||
<!-- | |||
===Elements I-O=== | ===Elements I-O=== | ||
{{XML entry | {{XML entry | ||
Line 1,319: | Line 1,333: | ||
| example = See coverage example. | | example = See coverage example. | ||
}} | }} | ||
--> | |||
<!--obsolete | <!--obsolete | ||
{{XML entry | {{XML entry | ||
Line 1,341: | Line 1,356: | ||
… | … | ||
}}--> | }}--> | ||
<!-- | |||
{{XML entry | {{XML entry | ||
| name = menu_item | | name = menu_item | ||
Line 1,354: | Line 1,369: | ||
| example = See the model example. | | example = See the model example. | ||
}} | }} | ||
--> | |||
<!--obsolete | <!--obsolete | ||
{{XML entry | {{XML entry | ||
Line 1,377: | Line 1,393: | ||
< /table > | < /table > | ||
}}--> | }}--> | ||
<!-- | |||
{{XML entry | {{XML entry | ||
| name = model | | name = model | ||
Line 1,530: | Line 1,546: | ||
===Elements P-S=== | ===Elements P-S=== | ||
--> | |||
<!--obsolete | <!--obsolete | ||
{{XML entry | {{XML entry | ||
Line 1,541: | Line 1,558: | ||
| example = | | example = | ||
}}--> | }}--> | ||
<!-- | |||
{{XML entry | {{XML entry | ||
| name = point_att | | name = point_att | ||
Line 1,714: | Line 1,731: | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]] | | used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_arc>|process_each_arc]], [[SMS:Dynamic Model Interface Schema#Element <process_each_point>|process_each_point]] | ||
| example = | | example = | ||
}} | |||
{{XML entry | |||
| name = process_selector | |||
| info = | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | |||
| example = | |||
}} | |||
{{XML entry | |||
| name = process_spectral_grid | |||
| info = Indicator to loop through spectral grid data. | |||
| version = 2 | |||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_read>|ignore_on_read]], [[SMS:Dynamic Model Interface Schema#Attribute <ignore_on_write>|ignore_on_write]], [[SMS:Dynamic Model Interface Schema#Attribute <order>|order]], [[SMS:Dynamic Model Interface Schema#Attribute <i_order>|i_order]], [[SMS:Dynamic Model Interface Schema#Attribute <j_order>|j_order]], source | |||
| children = [[SMS:Dynamic Model Interface Schema#Element <card_name>|card_name]], [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <separator>|separator]], [[SMS:Dynamic Model Interface Schema#Element <export_group>|export_group]], [[SMS:Dynamic Model Interface Schema#Element <export_optional>|export_optional]], [[SMS:Dynamic Model Interface Schema#Element <process_on_condition>|process_on_condition]], [[SMS:Dynamic Model Interface Schema#Element <section>|section]], [[SMS:Dynamic Model Interface Schema#Element <process_each_polygon>|process_each_polygon]], [[SMS:Dynamic Model Interface Schema#Element <process_each_material>|process_each_material]], [[SMS:Dynamic Model Interface Schema#Element <executable_command>|executable_command]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]] | |||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <process_each_coverage>|process_each_coverage]] | |||
| example = | |||
}} | }} | ||
Line 1,836: | Line 1,875: | ||
| attributes = none | | attributes = none | ||
| children = none | | children = none | ||
| used_by = | | used_by = | ||
| example = | | example = | ||
}} | }} | ||
Line 1,846: | Line 1,885: | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_icon>|use_icon]] | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <use_icon>|use_icon]] | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <takes>|takes]], [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <input_files>|input_files]], [[SMS:Dynamic Model Interface Schema#Element <output_files>|output_files]] | | children = [[SMS:Dynamic Model Interface Schema#Element <takes>|takes]], [[SMS:Dynamic Model Interface Schema#Element <executable>|executable]], [[SMS:Dynamic Model Interface Schema#Element <menu_item>|menu_item]], [[SMS:Dynamic Model Interface Schema#Element <input_files>|input_files]], [[SMS:Dynamic Model Interface Schema#Element <output_files>|output_files]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | | used_by = [[SMS:Dynamic Model Interface Schema#Element <control_executable>|control_executable]], [[SMS:Dynamic Model Interface Schema#Element <model>|model]] | ||
| example = See the model example. | | example = See the model example. | ||
}} | }} | ||
Line 2,080: | Line 2,119: | ||
| attributes = none | | attributes = none | ||
| children = none | | children = none | ||
| used_by = anything beginning with " | | used_by = anything beginning with "process_", [[SMS:Dynamic Model Interface Schema#Element <card>|card]], [[SMS:Dynamic Model Interface Schema#Element <control_dataset>|control_dataset]] | ||
| example = | | example = | ||
}} | }} | ||
Line 2,112: | Line 2,151: | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <datatype>|datatype]] | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <datatype>|datatype]] | ||
| children = [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], [[SMS:Dynamic Model Interface Schema#Element <export>|export]] | | children = [[SMS:Dynamic Model Interface Schema#Element <export_format>|export_format]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], [[SMS:Dynamic Model Interface Schema#Element <export>|export]] | ||
| used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], file_def, and anything beginning with " | | used_by = [[SMS:Dynamic Model Interface Schema#Element <xmdf_group>|xmdf_group]], file_def, and anything beginning with "process_". | ||
| example = This writes out 6 different widgets’ values, one on each row. | | example = This writes out 6 different widgets’ values, one on each row. | ||
<xmdf_data datatype = "text"> | <xmdf_data datatype = "text"> | ||
Line 2,198: | Line 2,237: | ||
| version = 3 | | version = 3 | ||
| attributes = [[SMS:Dynamic Model Interface Schema#Attribute <group_type>|group_type]] | | attributes = [[SMS:Dynamic Model Interface Schema#Attribute <group_type>|group_type]] | ||
| children = xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], and anything beginning with " | | children = xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_data>|xmdf_data]], [[SMS:Dynamic Model Interface Schema#Element <title_format>|title_format]], and anything beginning with "process_". | ||
| used_by = file_def, xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], and anything beginning with " | | used_by = file_def, xmdf_group, [[SMS:Dynamic Model Interface Schema#Element <xmdf_geometry>|xmdf_geometry]], [[SMS:Dynamic Model Interface Schema#Element <xmdf_dataset>|xmdf_dataset]], and anything beginning with "process_". | ||
| example = | | example = | ||
}} | }} | ||
Line 2,749: | Line 2,788: | ||
{{XML attributes | {{XML attributes | ||
| name = unique_name | | name = unique_name | ||
| info = A unique name given to an widget, which determines how to reference the widget. | | info = A unique name given to an widget, which determines how to reference the widget. When a unique_name is being referenced it should be by the file (nothing if current file), then unique_name. No spaces or punctuation (except _) are allowed in the name. The name must contain at least 1 non-numeric letter. The name must be unique. Names are not case sensitive, hence "aaa" is the same as "AAA". | ||
| values = string (unique) | | values = string (unique) | ||
| versions = 1 | | versions = 1 | ||
Line 2,830: | Line 2,869: | ||
For more information on using the Dynamic Model Interface, download the XML file tutorial: | For more information on using the Dynamic Model Interface, download the XML file tutorial: | ||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMI_XML_File.pdf DMI XML File Tutorial] | * [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMI_XML_File.pdf DMI XML File Tutorial] | ||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DynamicSample.zip DMI Tutorial Data] | * [http://smsdocs.aquaveo.com.s3.amazonaws.com/DynamicSample.zip DMI Tutorial Data] | ||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISamplePreProc.exe DMI Sample Pre-Processing Executable] | * [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISamplePreProc.exe DMI Sample Pre-Processing Executable] | ||
* [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISample.exe DMI Sample Executable] | * [http://smsdocs.aquaveo.com.s3.amazonaws.com/DMISample.exe DMI Sample Executable] | ||
--> | |||
{{Navbox SMS}} | {{Navbox SMS}} |
Latest revision as of 16:04, 4 March 2019
SMS – Surface-water Modeling System | ||
---|---|---|
Modules: | 1D Grid • Cartesian Grid • Curvilinear Grid • GIS • Map • Mesh • Particle • Quadtree • Raster • Scatter • UGrid | ![]() |
General Models: | 3D Structure • FVCOM • Generic • PTM | |
Coastal Models: | ADCIRC • BOUSS-2D • CGWAVE • CMS-Flow • CMS-Wave • GenCade • STWAVE • WAM | |
Riverine/Estuarine Models: | AdH • HEC-RAS • HYDRO AS-2D • RMA2 • RMA4 • SRH-2D • TUFLOW • TUFLOW FV | |
Aquaveo • SMS Tutorials • SMS Workflows |