SMS:Preferences: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The ''Edit'' | '''Preferences''' command brings up the ''Preferences'' dialog. The ''Preferences'' dialog contains the following tabs:
The ''Edit'' | '''Preferences''' command brings up the ''Preferences'' dialog. The ''Preferences'' dialog contains the following tabs:


==General==
== General ==
[[Image:SMS Pref General.png|thumb|400 px|''SMS Preferences'' dialog showing the ''General'' tab.]]
[[Image:SMS Pref General.png|thumb|400 px|''SMS Preferences'' dialog showing the ''General'' tab.]]
* ''File IO''
* ''File IO''
** ''Compress XMDF Files'' – Use compression when saving [[XMDF]] files.
** ''Compress XMDF Files'' – Use compression when saving [[XMDF]] files.
** ''Override temp directory'' – Specify the location where SMS temporary files are written.
** ''Override temp directory'' – Specify the location where SMS temporary files are written.
*''Help Option''
*''Help Option''
Line 15: Line 15:
* ''Deletions''
* ''Deletions''
** ''Confirm Deletions'' – Choose to be prompted to confirm the deletion whenever a set of selected objects is about to be deleted. This is meant to prevent accidental deletion of objects.
** ''Confirm Deletions'' – Choose to be prompted to confirm the deletion whenever a set of selected objects is about to be deleted. This is meant to prevent accidental deletion of objects.
* ''Model Priority'' – Models can be launched using a particular process priority. This priority specifies how the operating system should treat the process. We recommend using the "Above Normal", "Normal", or "Below Normal" options in most circumstances. The options are as follows:
* ''Model Priority'' – Models can be launched using a particular process priority. This priority specifies how the operating system should treat the process. In most circumstances the "Above Normal", "Normal", or "Below Normal" options are recommended. The options are as follows:
** "Realtime" – Highest priority. May cause machine to become unresponsive. Use with extreme care.
** "Realtime" – Highest priority. May cause machine to become unresponsive. Use with extreme care.
** "High" – Only allows realtime process to go before it. Can use nearly all CPU cycles. Use with extreme care.
** "High" – Only allows realtime process to go before it. Can use nearly all CPU cycles. Use with extreme care.
Line 27: Line 27:
* ''Print Options'' – When printing the contents of the main graphics window to a printer, the background color of the graphics window will be treated as if it is white when this option is selected.
* ''Print Options'' – When printing the contents of the main graphics window to a printer, the background color of the graphics window will be treated as if it is white when this option is selected.
[[File:DefaultTransContourRange.png|thumb|260 px|The ''Default Transient Contour Range'' dialog]]
[[File:DefaultTransContourRange.png|thumb|260 px|The ''Default Transient Contour Range'' dialog]]
* ''Transient Contours'' – The ''Default Range Options'' button launches the ''Default Transient Contour Range'' dialog. This dialog allows the user to determine how SMS computes the default range for contour options. The factory preference is to use union of all time steps in the current dataset. However, some models include ''spin up'' or ''ramp'' times during which the numerical results are not in a typical range. For example, a model which supports ''dry'' initial conditions will simulate a surge or flood wave as the water moves through the domain initially. This rapidly varied front could result in much larger than typical velocities. This option provides an method for instructing SMS to skip these atypical or unreasonable values from impacting the default ranges of the contours computed. The option for default contour range is display in the contour options dialog box. Options include:
* ''Transient Contours'' – The ''Default Range Options'' button launches the ''Default Transient Contour Range'' dialog. This dialog allows the user to determine how SMS computes the default range for contour options. The factory preference is to use union of all time steps in the current dataset. However, some models include ''spin up'' or ''ramp'' times during which the numerical results are not in a typical range. For example, a model which supports ''dry'' initial conditions will simulate a surge or flood wave as the water moves through the domain initially. This rapidly varied front could result in much larger than typical velocities. This option provides an method for instructing SMS to skip these atypical or unreasonable values from impacting the default ranges of the contours computed. The option for default contour range is display in the contour options dialog box. Options include:
** ''Skip (n) time steps'' – This option will skip the first n time steps. If less than n time steps exist in the current dataset, the last time step is used. Setting this value to a large integer would cause SMS to always use the last time step range as the default range.
** ''Skip (n) time steps'' – This option will skip the first n time steps. If less than n time steps exist in the current dataset, the last time step is used. Setting this value to a large integer would cause SMS to always use the last time step range as the default range.
** ''Skip (n) hrs'' – This option will skip the first n hours of time steps. If less than n hours of data exist in the current dataset, the last time step is used. Setting this value to a large floating point number would cause SMS to always use the last time step range as the default range.
** ''Skip (n) hrs'' – This option will skip the first n hours of time steps. If less than n hours of data exist in the current dataset, the last time step is used. Setting this value to a large floating point number would cause SMS to always use the last time step range as the default range.
** ''Use current time step'' – This option instructs SMS to always use the range of the current time step as the default range.
** ''Use current time step'' – This option instructs SMS to always use the range of the current time step as the default range.
*''Icon Options'' – Allows changing the display size of icons in the interface.
**''Icon size'' – Specifies the display size for icons.
***"Auto" – The default icon display size.
***"Small" – Causes the icons to be displayed at a smaller size; around 9 pixels wide.
***"Large" – Causes the icons to be displayed at a larger size; around 27 pixels wide.
*''Model Run'' – Options for processes that can run in conjunction with the model run.
**''Run checks before adding to Run Queue'' – When turned on, the model check will run before the model is added to the run queue. If errors are found, a prompt will appear and the model will not be added to the run queue.
**''Prompt before unloading solution datasets'' – When turned on, a warning will appear if the solution datasets need to be removed from the project before the model can run, for example when running the same simulation again. When turned off, the solution datasets will be removed without any warning.


==Defaults==
== Defaults ==
[[Image:SMS Pref Startup.png|thumb|400 px|''SMS Preferences'' dialog showing the ''Defaults'' tab.]]
[[Image:SMS Pref Startup.png|thumb|400 px|''SMS Preferences'' dialog showing the ''Defaults'' tab.]]
The ''Defaults'' tab was previously referred to as the ''Startup'' tab. It allows defining which modules and models are active by default when SMS is launched.
The ''Defaults'' tab was previously referred to as the ''Startup'' tab. It allows defining which modules and models are active by default when SMS is launched.
* ''Default Module'' – In this combo box, specify which module is active module at startup.
* ''Default Module'' – In this combo box, specify which module is active module at startup.
* ''Default 2D Mesh Model'' – In this combo box, specify which numerical engine (model) will be assigned to newly created meshes. This is the active [[SMS:Mesh Module|2D Mesh Module]] Model at startup.  As SMS migrates to simulation based modeling, the application of this tool will be less important because simulations will be explicitly created for a specific numerical engine.
* ''Default 2D Mesh Model'' – When SMS operated on a mesh based modeling system, each mesh would be associated with a specific numeric model. With the transition to the [[SMS:Simulations#Working_with_Simulations|Simulation]] based approach, the mesh is a generic entity that can be applied to simulations of multiple types at the same time. For this reason, the default option for this drop-down menu is a ''Generic Mesh'' and changing it is not recommended. Currently, this active [[SMS:Mesh Module|2D Mesh Module]] Model at startup can be set to:
* ''Default 2D Cartesian Grid Model'' – In this combo box, specify which model will be assigned to newly created Cartesian grids. This is the active [[SMS:Cartesian Grid Module|2D Cartesian Grid]] Module Model at startup. The need for this command will also go away as SMS migrates to simulation based modeling and simulations are created for a specific numerical engine.
** Generic Mesh – This is the recommended option. A mesh of this type can be applied to any simulation based model.
* ''Default Coverage Type'' – In this combo box, specify the active [[SMS:Map Module|Map Module]] Coverage Type at startup. Currently, SMS always requires at least one coverage to exist in a session. This coverage type controls the type of that new, blank coverage as well as the default type of newly created coverages. In most commands, there is an option to specify or change the type of the coverage as it is being created.
** CGWAVE – This option is retained for use with CGWAVE phase resolved wave interaction models.
* ''Check version on startup'' – This command instructs SMS to check, via an internet query for an update to SMS from Aquaveo. If the user machine is behind a firewall that does not allow access to the internet, this command will not function properly.
** TABS – This option is retained for historic RMA2/RMA4 models.
<!--obsolete * ''Default TUFLOW Executable'' &ndash; Specify the executable to use by default when creating a new [[SMS:TUFLOW|TUFLOW]] simulation. The options are double and single precision for both 32 and 64bit.-->
** Generic Model &ndash; This option is retained for historic generic model interface models.
** ADH
* ''Default 2D Cartesian Grid Model'' &ndash; Because of the transition to the [[SMS:Simulations#Working_with_Simulations|Simulation]] based approach, the default option for this drop-down menu is a ''Generic Cell-Centered Grid'' which is used for multiple engines including STWAVE and CMS-Wave. Currently, this active [[SMS:Cartesian Grid Module|2D Cartesian Grid]] Model at startup can be set to:
** BOUSS-2D &ndash; This option is retained for use with the BOUSS-2D phase resolved wave interaction models.
** TUFLOW &ndash; This option is retained for use with the TUFLOW classic engine.
** WAM
* ''Default Coverage Type'' &ndash; In this drop-down menu, specify the active [[SMS:Map Module|Map Module]] Coverage Type at startup. Currently, SMS always requires at least one coverage to exist in a session. This coverage type controls the type of that new, blank coverage as well as the default type of newly created coverages. There is an option to specify or change the type of the coverage as it is being created. Existing coverages can also be converted to another type at any time.
* ''Check version on startup'' &ndash; This command instructs SMS to check, via an internet query for an update to SMS from Aquaveo. If the user machine is behind a firewall that does not allow access to the internet, this command will not function properly.
<!--obsolete * ''Default TUFLOW Executable'' &ndash; Specify the executable to use by default when creating a new [[SMS:TUFLOW|TUFLOW]] simulation. The options are double and single precision for both 32 and 64bit.-->


==Images==
== File Locations ==
The images tab includes preferences related to the display and manipulation of images in SMS. Dynamic images or images loaded from web sources are available based on location of the simulation. Specific preferences include:
[[Image:SMS Pref File.png|thumb|400 px|''SMS Preferences'' dialog showing the ''File Locations'' tab.]]
* ''Image Pyramids'' &ndash; This function specifies whether SMS will "Always Build", "Never Build", or "Prompt for Each Image" when building [[Image Pyramids|image pyramids]]. It's recommended that this option be set to or left at "Never Build" unless a very large static image file is being used. This recommendation comes from multiple sources.  First, since web sources are much more standard, and image pyramids don't apply to dynamic images, the command is superfluous.  Second, the creation of image pyramids results in the several new image files saved on the user's local machine. The images are multiple resolution representations of a specified loaded image.  The creation of these images has led to confusion.  
This tab allows the specification of the location of applications and folders that may be used in the course of an SMS session. Once a new target is specified, SMS remembers that location for all future instances of the application until the program is reinstalled or the location is changed manually. This tab will only shows models with an active license.
* ''Save'' &ndash; Specifies where SMS saves temporary and/or created images. Options include a specific "Image Folder" or the "Temporary Folder" (as specified int eh General tab above). The image folder is created in the directory with the SMS project. Images are created either from the command to convert the graphics window to image format, or when converting dynamic images to static images to reduce dependency on an internet connection and speed up image refresh.
*''Model Executables'' &ndash; This table occupies the upper section of the tab and allows specifying the location of numerical model executables. Some models include only a single executable, others include two, three, or more. The installation will include a sub-folder for each model installed with the SMS installation. <!--Both 32- and 64-bit versions of most numerical engines may be available.-->
[[Image:SMS Pref Images.jpg|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Images'' tab.]]
:Note: the default directory location for most model executables is: C:\Program Files\SMS **.* 64-bit\python\Lib\site-packages
:Note: The list of supported models is not static. It changes based on licensing as well as dynamic model interfaces that can be loaded at run time for SMS.


==File Locations==
[[Image:SMS Pref File.png|thumb|400 px|''SMS Preferences'' dialog showing the ''File Locations'' tab.]]
This tab allows specifying the location of applications and folders that may be used in the course of an SMS session. Once a new target is specified, SMS remembers that location for all future uses of the application. This tab will only shows models with an active license.
*''Model Executables'' &ndash; This table occupies the upper section of the tab and allows specifying the location of numerical model executables. Some models include only a single executable, others include two, three or four.  By default, an SMS installation is initialized to look in the ''models'' directory in the folder where the SMS program is installed. The installation will include a sub-folder for each model installed with the SMS installation. Both 32 and 64-bit versions of most numerical engines are available.
*''Other Files'' &ndash; This table occupies the lower section of the tab and allows specifying the location of resource files that may be utilized during an SMS session. These files include:
*''Other Files'' &ndash; This table occupies the lower section of the tab and allows specifying the location of resource files that may be utilized during an SMS session. These files include:
** The [[SMS:ADCIRC Model Control|LeProvost tidal database]].
** LATLON conversion files: A utility to assist in the conversion from geographic projections/distances to georectified values.
** The location of a resource folder containing bitmaps of ''North Arrow'' representation to be used by the annotation tools. Aquaveo provides several default bitmaps. Individual users can create custom bitmaps for this use.
** The location of a resource folder containing bitmaps of ''North Arrow'' representation to be used by the annotation tools. Aquaveo provides several default bitmaps. Individual users can create custom bitmaps for this use. By default this folder is installed beneath the SMS installation folder.
** The path to the log file for TUFLOW simlations
** The path to the log file for TUFLOW simulations.
** The path to the MPIEXEC application which is utilized for MPI parallel process execution.
<!--** The path to the Intel MPIEXEC application which is utilized for ADCIRC and similar MPI parallel process execution.
** The path to the Microsoft MPIEXEC application which is utilized for AdH and similar MPI parallel process execution.-->
** Various other resources that are currently under investigation.
** Various other resources that are currently under investigation.


==Project Explorer==
Note: The link to the [[SMS:ADCIRC Model Control|LeProvost tidal database]] has been replaced with a more general tidal database tool that can access not only the Leprovost and ADCIRC tidal databases, but also the FES and TPX0 databases.
The ''Project Explorer'' tab provides preferences for interacting with the data tree in the Project Explorer. Supported options include:  
 
* Force active scalar and vector datasets to be in the same folder &ndash; When this option is selected, the scalar and vector datasets selected for any geometric object (mesh, grid, scatter set, boundary fitted grid, ..) must be in the same folder. If a scalar dataset is selected in a different folder in the Project Explorer, the first vector dataset (if one exists) will also be selected. If a vector dataset in a different folder is selected, the first scalar dataset in that folder will be selected.
== Project Explorer ==
* Add diagnostic files when reading model solutions. If this toggle is selected, SMS will add an entry to the Project Explorer data tree to link to the diagnostic (text messages) file associated with a numerical simulation. Not all numerical engines support this type of a file.
[[Image:SMS Pref Project.png|none|left|thumb|400 px|''SMS Preferences'' dialog showing the ''Project Explorer'' tab.]]
[[Image:SMS Pref Project.png|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Project Explorer'' tab.]]
The ''Project Explorer'' tab provides preferences for interacting with the data tree in the Project Explorer. Supported options include:  
* ''Force active scalar and vector datasets to be in the same folder'' &ndash; When this option is selected, the scalar and vector datasets selected for any geometric object (mesh, grid, scatter set, boundary fitted grid, ...) must be in the same folder. If a scalar dataset is selected in a different folder in the Project Explorer, the first vector dataset (if one exists) will also be selected. If a vector dataset in a different folder is selected, the first scalar dataset in that folder will be selected.
* ''Add diagnostic files when reading model solutions.'' &ndash; If this option is selected, SMS will add an entry to the Project Explorer data tree to link to the diagnostic (text messages) file associated with a numerical simulation. Not all numerical engines support this type of a file.
* ''Simulation right-click menu options'' &ndash; Clicking the '''Edit''' button next to this option will open the ''Simulation Menu Preferences'' dialog.
=== Simulation Menu Preferences ===
The ''Simulation Menu Preferences'' dialog can be accessed through the ''Project Explorer'' tab of the ''SMS Preferences'' dialog.
{{Simulation Menu Preferences}}


==Toolbars==
== Toolbars ==
[[Image:SMS Pref Toolbars.jpg|thumb|400 px|''SMS Preferences'' dialog showing the ''Toolbars'' tab.]]
[[Image:SMS Pref Toolbars.png|thumb|400 px|''SMS Preferences'' dialog showing the ''Toolbars'' tab.]]
The toolbar tab allows controlling the status and position of each toolbar in SMS at startup. These positions/status values can be changed by dragging each individual toolbar during a session of SMS. The toggle box to the left of the toolbar controls whether the toolbar will be visible when SMS start. The toolbars included in this feature include:
The toolbar tab allows controlling the status and position of each toolbar in SMS at startup. These positions/status values can be changed by dragging each individual toolbar during a session of SMS. The toggle box to the left of the toolbar controls whether the toolbar will be visible when SMS start. The toolbars included in this feature include:
* [[SMS:Macros|''File Toolbar'']] &ndash; This toolbar includes the four ''File'' menu commands (Open, Save, Print and Delete). By default it is visible and it appears at the top of the screen between the menu bar and the Project Explorer.
* [[SMS:Macros|''File Toolbar'']] &ndash; This toolbar includes the four ''File'' menu commands (Open, Save, Print and Delete). By default it is visible and it appears at the top of the screen between the menu bar and the Project Explorer.
* [[SMS:Modules|''Module Toolbar'']] &ndash; This toolbar includes the modules. In early versions of SMS it was the only way to switch between modules and was commonly used for navigation. With the addition of the Project Explorer, the module toolbar was less essential. It is still ON by default, but was moved to the bottom of the screen below the Project Explorer as a default location.
* [[SMS:Modules|''Module Toolbar'']] &ndash; This toolbar includes the modules. In early versions of SMS it was the only way to switch between modules and was commonly used for navigation. With the addition of the Project Explorer, the module toolbar was less essential. It is still ON by default, but was moved to the bottom of the screen below the Project Explorer as a default location.
* [[SMS:Macros|''Display Toolbar'']] &ndash; This toolbar includes the principal ''Display'' menu commands (Refresh, Frame, Display Options and Plan View). By default it is visible and it appears at the top of the screen between the menu bar and the project explorer.
* [[SMS:Macros|''Display Toolbar'']] &ndash; This toolbar includes the principal ''Display'' menu commands (Refresh, Frame, Display Options and Plan View). By default it is visible and it appears at the top of the screen between the menu bar and the project explorer.
* [[SMS:Macros|''Optional Macro'']] &ndash; This toolbar includes the secondary ''Display'' menu commands (Lighting, Contour Options, Vector Options, Info, Plot, and Web data). By default it is visible and it appears at the bottom of the graphics window.
* [[SMS:Macros|''Optional Macro'']] &ndash; This toolbar includes the secondary ''Display'' menu commands (Lighting, Contour Options, Vector Options, Info, Plot, and Web data). By default it is visible and it appears at the bottom of the graphics window.
* [[SMS:Edit Window|''Edit Window'']] &ndash; This toolbar includes the edit fields for viewing/specifying the coordinates of a selected point/vertex/cell and the associated dataset values. It appears at the top of the Graphics Window.
* [[SMS:Edit Window|''Edit Window'']] &ndash; This toolbar includes the edit fields for viewing/specifying the coordinates of a selected point/vertex/cell and the associated dataset values. It appears at the top of the Graphics Window.
* [[SMS:Data_Toolbar|''Data Toolbar'']] &ndash; This toolbar includes the Measure tool and Get Image tool.
* [[SMS:Data_Toolbar|''Data Toolbar'']] &ndash; This toolbar includes the Measure tool and Get Image tool.


==Time==
== Time ==
[[Image:SMS Pref Time.jpg|thumb|400 px|''SMS Preferences'' dialog showing the ''Time'' tab.]]
[[Image:SMS Pref Time.png|thumb|400 px|''SMS Preferences'' dialog showing the ''Time'' tab.]]
See the [[SMS:Time Steps Window|Time Steps window]] article for an explanation of absolute and relative time.  
See the [[SMS:Time Steps Window|Time Steps window]] article for an explanation of absolute and relative time.  
The default format of the time steps in the [[SMS:Time Steps Window|Time Steps window]] can be set.  
The default format of the time steps in the [[SMS:Time Steps Window|Time Steps window]] can be set.  
Line 90: Line 110:
* "Use nearest time" &ndash; The dataset time step nearest the display time will be used (no interpolation).
* "Use nearest time" &ndash; The dataset time step nearest the display time will be used (no interpolation).


==Map==
== Map ==
This tab includes an options to ''Snap feature objects to displayed inactive coverage nodes and vertices'' when creating new feature objects. This allows creating objects in one coverage that are aligned with objects in another coverage.
This tab includes an options to ''Snap feature objects to displayed inactive coverage nodes and vertices'' when creating new feature objects. This allows creating objects in one coverage that are aligned with objects in another coverage.
[[Image:SMS Pref Map.jpg|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Map'' tab.]]
[[Image:SMS Pref Map.png|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Map'' tab.]]


==Graphics==
== Graphics ==
* ''Active Graphics Library''
<!--* ''Active Graphics Library''-->
* ''Options''
* ''Options''
** ''Automatically refresh after an edge swap''
** ''Automatically refresh after an edge swap''
** ''Use vertex buffer objects (VBOs)'' &ndash; This option can be specified to change how SMS works with the graphics card. Vertex buffer objects are generally faster and often uses less of the computers main memory. However, there are circumstances where using vertex buffer objects can be significantly slower, such as when the machine's graphics card only has a small amount of onboard memory. By default, this option is on.
<!--** ''Use vertex buffer objects (VBOs)'' &ndash; This option can be specified to change how SMS works with the graphics card. Vertex buffer objects are generally faster and often uses less of the computers main memory. However, there are circumstances where using vertex buffer objects can be significantly slower, such as when the machine's graphics card only has a small amount of onboard memory. By default, this option is on.-->
[[Image:SMS Pref Graphics.jpg|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Graphics'' tab.]]
[[Image:SMS Pref Graphics.png|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Graphics'' tab.]]


==Mesh==
== Mesh ==
This tab includes an option to specify the precision that will be used to output "2dm" mesh files from SMS.
This tab includes an option to specify the precision that will be used to output "2dm" mesh files from SMS.


[[File:SMS Preferences Mesh.jpg|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Mesh'' tab.]]
[[File:SMS Preferences Mesh.png|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Mesh'' tab.]]
 
== Licensing ==
This tab shows information about the application license.
*''Use Legacy Licensing'' &ndash; Turning on will revert to using older licenses.
*''Information'' &ndash; Shows information about the license being used.
[[File:SMS Pref Licensing.png|thumb|none|left|400 px|''SMS Preferences'' dialog showing the ''Licensing'' tab.]]


==Related Topics==
== Related Topics ==
* [[SMS:Edit Menu|Edit Menu]]  
* [[SMS:Edit Menu|Edit Menu]]  
* [[SMS:Time Settings|Time Settings]]
* [[SMS:Time Settings|Time Settings]]

Latest revision as of 22:09, 26 September 2024

The Edit | Preferences command brings up the Preferences dialog. The Preferences dialog contains the following tabs:

General

SMS Preferences dialog showing the General tab.
  • File IO
    • Compress XMDF Files – Use compression when saving XMDF files.
    • Override temp directory – Specify the location where SMS temporary files are written.
  • Help Option
    • Use local help – Option to access the CHM file include with SMS when the Help button in a dialog is pressed.
    • Use online help – Option to access the XMS Wiki when the Help button in a dialog is pressed.
    • 3rd party online – Allows specifying third-party help using the Dynamic Model Interface Schema.
    • Prompt
  • View Data File Option
    • Ask for Program – SMS will prompt to specify the program used to open a data file when the File | View Data File command is called.
  • Deletions
    • Confirm Deletions – Choose to be prompted to confirm the deletion whenever a set of selected objects is about to be deleted. This is meant to prevent accidental deletion of objects.
  • Model Priority – Models can be launched using a particular process priority. This priority specifies how the operating system should treat the process. In most circumstances the "Above Normal", "Normal", or "Below Normal" options are recommended. The options are as follows:
    • "Realtime" – Highest priority. May cause machine to become unresponsive. Use with extreme care.
    • "High" – Only allows realtime process to go before it. Can use nearly all CPU cycles. Use with extreme care.
    • "Above Normal" – Takes priority over normal processes. Will take CPU cycles before normal applications do.
    • "Normal" – No special scheduling takes place. This is the normal default.
    • "Below Normal" – Allows processes with normal priority to run first, but runs before low priority processes.
    • "Low" – The process will only run when the system is idle.
    • "Default" – The process will be launched with the same priority as it's parent (SMS in this case).
  • Copy to Clipboard
    • Scale factor – When copying the contents of the main graphics window to clipboard, the resolution can be increase by specifying a scale factor greater than 1.0.
  • Print Options – When printing the contents of the main graphics window to a printer, the background color of the graphics window will be treated as if it is white when this option is selected.
The Default Transient Contour Range dialog
  • Transient Contours – The Default Range Options button launches the Default Transient Contour Range dialog. This dialog allows the user to determine how SMS computes the default range for contour options. The factory preference is to use union of all time steps in the current dataset. However, some models include spin up or ramp times during which the numerical results are not in a typical range. For example, a model which supports dry initial conditions will simulate a surge or flood wave as the water moves through the domain initially. This rapidly varied front could result in much larger than typical velocities. This option provides an method for instructing SMS to skip these atypical or unreasonable values from impacting the default ranges of the contours computed. The option for default contour range is display in the contour options dialog box. Options include:
    • Skip (n) time steps – This option will skip the first n time steps. If less than n time steps exist in the current dataset, the last time step is used. Setting this value to a large integer would cause SMS to always use the last time step range as the default range.
    • Skip (n) hrs – This option will skip the first n hours of time steps. If less than n hours of data exist in the current dataset, the last time step is used. Setting this value to a large floating point number would cause SMS to always use the last time step range as the default range.
    • Use current time step – This option instructs SMS to always use the range of the current time step as the default range.
  • Icon Options – Allows changing the display size of icons in the interface.
    • Icon size – Specifies the display size for icons.
      • "Auto" – The default icon display size.
      • "Small" – Causes the icons to be displayed at a smaller size; around 9 pixels wide.
      • "Large" – Causes the icons to be displayed at a larger size; around 27 pixels wide.
  • Model Run – Options for processes that can run in conjunction with the model run.
    • Run checks before adding to Run Queue – When turned on, the model check will run before the model is added to the run queue. If errors are found, a prompt will appear and the model will not be added to the run queue.
    • Prompt before unloading solution datasets – When turned on, a warning will appear if the solution datasets need to be removed from the project before the model can run, for example when running the same simulation again. When turned off, the solution datasets will be removed without any warning.

Defaults

SMS Preferences dialog showing the Defaults tab.

The Defaults tab was previously referred to as the Startup tab. It allows defining which modules and models are active by default when SMS is launched.

  • Default Module – In this combo box, specify which module is active module at startup.
  • Default 2D Mesh Model – When SMS operated on a mesh based modeling system, each mesh would be associated with a specific numeric model. With the transition to the Simulation based approach, the mesh is a generic entity that can be applied to simulations of multiple types at the same time. For this reason, the default option for this drop-down menu is a Generic Mesh and changing it is not recommended. Currently, this active 2D Mesh Module Model at startup can be set to:
    • Generic Mesh – This is the recommended option. A mesh of this type can be applied to any simulation based model.
    • CGWAVE – This option is retained for use with CGWAVE phase resolved wave interaction models.
    • TABS – This option is retained for historic RMA2/RMA4 models.
    • Generic Model – This option is retained for historic generic model interface models.
    • ADH
  • Default 2D Cartesian Grid Model – Because of the transition to the Simulation based approach, the default option for this drop-down menu is a Generic Cell-Centered Grid which is used for multiple engines including STWAVE and CMS-Wave. Currently, this active 2D Cartesian Grid Model at startup can be set to:
    • BOUSS-2D – This option is retained for use with the BOUSS-2D phase resolved wave interaction models.
    • TUFLOW – This option is retained for use with the TUFLOW classic engine.
    • WAM
  • Default Coverage Type – In this drop-down menu, specify the active Map Module Coverage Type at startup. Currently, SMS always requires at least one coverage to exist in a session. This coverage type controls the type of that new, blank coverage as well as the default type of newly created coverages. There is an option to specify or change the type of the coverage as it is being created. Existing coverages can also be converted to another type at any time.
  • Check version on startup – This command instructs SMS to check, via an internet query for an update to SMS from Aquaveo. If the user machine is behind a firewall that does not allow access to the internet, this command will not function properly.

File Locations

SMS Preferences dialog showing the File Locations tab.

This tab allows the specification of the location of applications and folders that may be used in the course of an SMS session. Once a new target is specified, SMS remembers that location for all future instances of the application until the program is reinstalled or the location is changed manually. This tab will only shows models with an active license.

  • Model Executables – This table occupies the upper section of the tab and allows specifying the location of numerical model executables. Some models include only a single executable, others include two, three, or more. The installation will include a sub-folder for each model installed with the SMS installation.
Note: the default directory location for most model executables is: C:\Program Files\SMS **.* 64-bit\python\Lib\site-packages
Note: The list of supported models is not static. It changes based on licensing as well as dynamic model interfaces that can be loaded at run time for SMS.
  • Other Files – This table occupies the lower section of the tab and allows specifying the location of resource files that may be utilized during an SMS session. These files include:
    • LATLON conversion files: A utility to assist in the conversion from geographic projections/distances to georectified values.
    • The location of a resource folder containing bitmaps of North Arrow representation to be used by the annotation tools. Aquaveo provides several default bitmaps. Individual users can create custom bitmaps for this use. By default this folder is installed beneath the SMS installation folder.
    • The path to the log file for TUFLOW simulations.
    • Various other resources that are currently under investigation.

Note: The link to the LeProvost tidal database has been replaced with a more general tidal database tool that can access not only the Leprovost and ADCIRC tidal databases, but also the FES and TPX0 databases.

Project Explorer

SMS Preferences dialog showing the Project Explorer tab.

The Project Explorer tab provides preferences for interacting with the data tree in the Project Explorer. Supported options include:

  • Force active scalar and vector datasets to be in the same folder – When this option is selected, the scalar and vector datasets selected for any geometric object (mesh, grid, scatter set, boundary fitted grid, ...) must be in the same folder. If a scalar dataset is selected in a different folder in the Project Explorer, the first vector dataset (if one exists) will also be selected. If a vector dataset in a different folder is selected, the first scalar dataset in that folder will be selected.
  • Add diagnostic files when reading model solutions. – If this option is selected, SMS will add an entry to the Project Explorer data tree to link to the diagnostic (text messages) file associated with a numerical simulation. Not all numerical engines support this type of a file.
  • Simulation right-click menu options – Clicking the Edit button next to this option will open the Simulation Menu Preferences dialog.

Simulation Menu Preferences

The Simulation Menu Preferences dialog can be accessed through the Project Explorer tab of the SMS Preferences dialog.

The Simulation Menu Preferences dialog

The options in this dialog allow hiding or showing menu commands for the simulation right-click menus. The dialog has the following options:

  • Simulation – This section is for turning on and off commands located in the simulation right-click menu for individual simulations. It includes the following commands:
    • Save Simulation
    • Run Simulation
    • Save Simulation and Run
    • Save Project and Simulation
    • Save Project, Simulation and Run
  • All Simulations for Model – This section is for turning on and off commands for the simulation data right-click menu that affects all the simulations of a numeric model. This is accessed by right-clicking on the simulation folder Simulation Folder Icon.svg for each numerical model. It includes the following commands:
    • Save All Simulations
    • Run All Simulations
    • Save All Simulations and Run
    • Save Project and All Simulations
    • Save Project, All Simulations and Run
Note: Saving a project does not save files used by the numeric model for the simulation run. The simulation must be saved for these files to be exported from the project.
Note: Some models do not support a Save and/or Run command. Menus selected in this dialog may not appear for those models. For example, if the Save Simulation and Run was the only menu item selected, but the model only supports the Save command, then the Save Simulation command would appear instead of the Save Simulation and Run command.


Toolbars

SMS Preferences dialog showing the Toolbars tab.

The toolbar tab allows controlling the status and position of each toolbar in SMS at startup. These positions/status values can be changed by dragging each individual toolbar during a session of SMS. The toggle box to the left of the toolbar controls whether the toolbar will be visible when SMS start. The toolbars included in this feature include:

  • File Toolbar – This toolbar includes the four File menu commands (Open, Save, Print and Delete). By default it is visible and it appears at the top of the screen between the menu bar and the Project Explorer.
  • Module Toolbar – This toolbar includes the modules. In early versions of SMS it was the only way to switch between modules and was commonly used for navigation. With the addition of the Project Explorer, the module toolbar was less essential. It is still ON by default, but was moved to the bottom of the screen below the Project Explorer as a default location.
  • Display Toolbar – This toolbar includes the principal Display menu commands (Refresh, Frame, Display Options and Plan View). By default it is visible and it appears at the top of the screen between the menu bar and the project explorer.
  • Optional Macro – This toolbar includes the secondary Display menu commands (Lighting, Contour Options, Vector Options, Info, Plot, and Web data). By default it is visible and it appears at the bottom of the graphics window.
  • Edit Window – This toolbar includes the edit fields for viewing/specifying the coordinates of a selected point/vertex/cell and the associated dataset values. It appears at the top of the Graphics Window.
  • Data Toolbar – This toolbar includes the Measure tool and Get Image tool.

Time

SMS Preferences dialog showing the Time tab.

See the Time Steps window article for an explanation of absolute and relative time. The default format of the time steps in the Time Steps window can be set.

Available times options

This option controls which times are displayed in the Time Steps window. The available options are:

  • Active datasets (current module only) – The times displayed in the Time Steps window are based only upon the active scalar and vector datasets in the current module. If neither of these datasets is transient, the Time Steps window will not be displayed.
  • All available times (all modules) – The times displayed in the Time Step Window are based upon times used by any transient object in SMS (includes datasets, some kinds of coverages, and PTM particle sets). All of the times from each of the objects will be used regardless of whether or not the object is active or visible.

Dataset time step rounding

The dataset being used for contours, vectors, or other display option may not have a time step that corresponds exactly with the time currently chosen in the Time Steps window. When this happens, SMS has two options for determining the values used by the dataset. These options are:

  • "Interpolate to exact time" – Interpolate the dataset values for the selected time step from the nearest time steps before or after the display time. If the display time is before/after all of the time steps the nearest time step is used.
  • "Use nearest time" – The dataset time step nearest the display time will be used (no interpolation).

Map

This tab includes an options to Snap feature objects to displayed inactive coverage nodes and vertices when creating new feature objects. This allows creating objects in one coverage that are aligned with objects in another coverage.

SMS Preferences dialog showing the Map tab.

Graphics

  • Options
    • Automatically refresh after an edge swap
SMS Preferences dialog showing the Graphics tab.

Mesh

This tab includes an option to specify the precision that will be used to output "2dm" mesh files from SMS.

SMS Preferences dialog showing the Mesh tab.

Licensing

This tab shows information about the application license.

  • Use Legacy Licensing – Turning on will revert to using older licenses.
  • Information – Shows information about the license being used.
SMS Preferences dialog showing the Licensing tab.

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:Preferences&oldid=163604"