SMS:Toolbox: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOINDEX__
{{Version SMS 13.2}}
__TOC__
__TOC__
Starting with version 13.2 , SMS includes a general purpose toolbox that allows the SMS process to interact with external python scripts.  In SMS 13.2 this is a beta feature. For this version, the user accesses the toolbox by selecting the toolbox icon [[File:Toolbox macro.png|16px]] in the macro toolbar.  This bring up the SMS toolbox dialog.
Starting with version 13.2, SMS includes a general purpose toolbox that allows the SMS process to interact with external scripts.  This is a beta feature in 13.2 and 13.3. For these versions, the user accesses the toolbox by selecting the toolbox icon [[File:Toolbox macro.png|16px]] in the macro toolbar.  This brings up the SMS toolbox dialog.
==SMS Toolbox==
==SMS Toolbox==
Tools in the toolbox allow the user to operate on data in an SMS interactive session as well as data in external files.  Each tool in the toolbox links to a python script that produces a specific output.  Launch a tool by either double clicking on the tool or selecting the tool and clicking the "Run Tool..." button at the bottom of the toolbox.
Tools in the toolbox allow the user to operate on data in an SMS interactive session as well as data in external files.  Each tool in the toolbox produces a specific output.  Launch a tool by either double clicking on the tool or selecting the tool and clicking the "Run Tool..." button at the bottom of the toolbox.


Example output from a tool could include, but are not limited to:
Example output from a tool could include, but are not limited to:
Line 16: Line 14:


Available tools in the SMS Tool dialog are divided into categories, typically based on the type of output or the type of arguments used in the tool.  Currently these categories include:
Available tools in the SMS Tool dialog are divided into categories, typically based on the type of output or the type of arguments used in the tool.  Currently these categories include:
* [[SMS:ADCIRC Tools|''ADCIRC'']]
* [[SMS:2D Mesh Tools|''2D Mesh'']] – Contains tools for adding features into an ADCIRC model. (Available only in SMS 13.3)
* [[Coverage Tools|''Coverages'']]
* [[SMS:ADCIRC Tools|''ADCIRC'']] – Contains tools for adding features into an ADCIRC model.
* [[SMS:Auto-Backup Tools|''Auto-Backup'']] – Contains tools for backing up and reloading a mesh.
* [[Coverages Tools|''Coverages'']] – Contains tools for manipulated coverage data.
* [[Datasets Tools|''Datasets'']] – Contains tools for manipulating datasets attached meshes, scatters sets, or Ugrids.
* [[Datasets Tools|''Datasets'']] – Contains tools for manipulating datasets attached meshes, scatters sets, or Ugrids.
* [[Lidar Tools|''Lidar'']] –
* [[Lidar Tools|''Lidar'']] – Contains tools for manipulating lidar data.
* [[Raster Tools|''Rasters'']] – Contains tools for manipulating raster files in the GIS module.
* [[Rasters Tools|''Rasters'']] – Contains tools for manipulating raster files in the GIS module.
* [[UGrid Tools|''UGrids'']] – Contains tools for manipulating UGrids, scatter sets, and meshes.
* [[SMS:SCHISM Tools|''SCHISM'']] – Contains tools for the import and export of grid points and elements for a horizontal grid file for a SCHISM model. (Available only in SMS 13.3)
* [[UGrids Tools|''Unstructured Grids'']] – Contains tools for manipulating UGrids, scatter sets, and meshes.
* [https://www.whiteboxgeo.com/manual/wbt_book/tool_index.html ''Whitebox Tools''] – Contains tools for executing operations for analyzing geographical information systems (GIS).
<!--
<!--
  (Jeff - eventually we want a wiki article for each tool in the toolbox that is created or managed by Aquaveo.  These tools should be listed in an expandable list for each category and include a link to the tool's wiki article.)-->
  (Jeff - eventually we want a wiki article for each tool in the toolbox that is created or managed by Aquaveo.  These tools should be listed in an expandable list for each category and include a link to the tool's wiki article.)-->
Line 32: Line 34:
===History Tab===
===History Tab===


The toolbox maintains a history of all tools invoked for in an SMS project.
The toolbox maintains a history of all tools invoked in an SMS project.


The history section includes the tool and the date/time the tool was invoked. Selecting an entry in the history tab launches the listed tool. The input fields are populated with the arguments that were used in the previous invocation of the tool.  These inputs can be changed for the new invocation of the tool.
The history section includes the tool and the date/time the tool was invoked. Selecting an entry in the history tab launches the listed tool. The input fields are populated with the arguments that were used in the previous invocation of the tool.  These inputs can be changed for the new invocation of the tool.
Line 39: Line 41:
*'''Run Tool From History''' &ndash; Clicking this will run the tool again using the same parameters.
*'''Run Tool From History''' &ndash; Clicking this will run the tool again using the same parameters.
*'''Delete''' &ndash; Removes the run from the history.
*'''Delete''' &ndash; Removes the run from the history.
*'''Notes''' &ndash; Brings up the [[GMS:Notes|Notes]] dialog which allows notes to be attached to the run.
<!--*'''Notes''' &ndash; Brings up the [[GMS:Notes|Notes]] dialog which allows notes to be attached to the run.-->


==Related Topics==
==Related Topics==
Line 46: Line 48:


{{Navbox SMS}}
{{Navbox SMS}}
[[Category:Toolbox]]

Latest revision as of 17:12, 23 October 2023

Starting with version 13.2, SMS includes a general purpose toolbox that allows the SMS process to interact with external scripts. This is a beta feature in 13.2 and 13.3. For these versions, the user accesses the toolbox by selecting the toolbox icon Toolbox macro.png in the macro toolbar. This brings up the SMS toolbox dialog.

SMS Toolbox

Tools in the toolbox allow the user to operate on data in an SMS interactive session as well as data in external files. Each tool in the toolbox produces a specific output. Launch a tool by either double clicking on the tool or selecting the tool and clicking the "Run Tool..." button at the bottom of the toolbox.

Example output from a tool could include, but are not limited to:

  • a graphic or plot.
  • a report (document or spreadsheet) for a specified analytical process.
  • a new geometry item in SMS (i.e. a new mesh/Ugrid).
  • a new dataset in SMS.
  • a new data file.

Tools Tab

Available tools in the SMS Tool dialog are divided into categories, typically based on the type of output or the type of arguments used in the tool. Currently these categories include:

  • 2D Mesh – Contains tools for adding features into an ADCIRC model. (Available only in SMS 13.3)
  • ADCIRC – Contains tools for adding features into an ADCIRC model.
  • Auto-Backup – Contains tools for backing up and reloading a mesh.
  • Coverages – Contains tools for manipulated coverage data.
  • Datasets – Contains tools for manipulating datasets attached meshes, scatters sets, or Ugrids.
  • Lidar – Contains tools for manipulating lidar data.
  • Rasters – Contains tools for manipulating raster files in the GIS module.
  • SCHISM – Contains tools for the import and export of grid points and elements for a horizontal grid file for a SCHISM model. (Available only in SMS 13.3)
  • Unstructured Grids – Contains tools for manipulating UGrids, scatter sets, and meshes.
  • Whitebox Tools – Contains tools for executing operations for analyzing geographical information systems (GIS).

History Tab

The toolbox maintains a history of all tools invoked in an SMS project.

The history section includes the tool and the date/time the tool was invoked. Selecting an entry in the history tab launches the listed tool. The input fields are populated with the arguments that were used in the previous invocation of the tool. These inputs can be changed for the new invocation of the tool.

The History tab has the following options:

  • Run Tool From History – Clicking this will run the tool again using the same parameters.
  • Delete – Removes the run from the history.

Related Topics


v • e
SMS – Surface-water Modeling System
Modules:1D Grid  •   Cartesian Grid  •   Curvilinear Grid  •   GIS  •   Map  •   Mesh  •  Particle  •   Quadtree  •  Raster  •   Scatter   •   UGridSMS.png
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
Retrieved from "https://www.xmswiki.com/index.php?title=SMS:Toolbox&oldid=160427"