optiSLang Configuration

You can change configuration settings for optiSLang by either selecting Edit > Settings from the menu bar or directly in the optiSLang.ini configuration file.

By default, the configuration file location is platform dependent.

Linux: $HOME/.config/Ansys/optiSLang
Windows: %APPDATA%\Ansys\optiSLang

Alternatively, the file can also be located in:

The installation directory [installation path]
The directory specified by the environment variable OSL_CENTRAL_CONFIG_FILE

The following tables provide an overview of the available configuration settings. The value stated in the Configuration File ID column refers to the ID of the attribute in the configuration file (optiSLang.ini). When editing the file directly, search for and edit the corresponding entry in the [customization] section of the file.

Ansys Workbench Integration

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_AnsysWBExecutableFinishTimeOut	Executable finish timeout (s)	Sets the timeout to wait for finishing the Ansys Workbench executable, in seconds.	N	[1 : ∞] / 60
IM_AnsysWBExecutableStartTimeOut	Executable start timeout (s)	Sets the timeout to wait for starting the Ansys Workbench executable, in seconds.	N	[1 : ∞] / 300
SC_AnsysWBPortRange	Port range	Sets the port range for multicast and communication.	Y	[49152-65535] / [49690-49710]
IM_AnsysWBProjectDetectionTimeOut	Project detect timeout (s)	Sets the timeout to detect Ansys Workbench projects in the network, in seconds.	N	[1 : ∞] / 2
IM_AnsysWBProjectLoadTimeOut	Project load timeout (s)	Sets the timeout to wait for loading a Ansys project, in seconds.	N	[1 : ∞] / 60
IM_AnsysWBProjectStartDelayTime	Project start delay (s)	Sets the time to wait for starting the next Ansys Workbench project, in seconds.	N	[1 : ∞] / 15
SC_ReferenceFilesDir	Reference files directory	Sets the directory for back-up copies and temporary files of projects connected to the Ansys Workbench node.	Y	reffildir

Application

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_ClearMessageLogBeforeRun	Clear Message log before run	When selected, message log is cleared when starting a project run.	N	1 (True)
SC_CommonWorkingDirectory	Default filechooser path	Sets the directory to start to browse for files.	Y	N/A
FM_ApplicationBaseFontSize	Default font size	Sets the base font size of the application. If set to -1, the systems default font size is used.	Y	[-1 : 64] / -1
SC_DesignDirectoryFormat	Design directory format	Sets the format used to create design directories.	Y	Design%04d
IM_EscapeFileNames	Enable file name escaping	When selected, allows you to add special characters to file names.	N	1 (True)
IM_ProcessKillOnStop	Forcefully terminate processes on 'Stop'	When selected, processes launched by process nodes are forcefully terminated if system execution is stopped.	N	0 (False)
IM_LogActorExecutionTime	Log actor execution time	When selected, displays actor execution time in the message log.	N	0 (False)
IM_DegreeOfParallelism	Maximum global degree of parallelism	Defines an upper limit for the number of actors allowed to run at the same time throughout the entire optiSLang project. This setting has priority over node-related degree of parallelization settings. It considers all types of actors like process nodes, integration nodes, text input/output, and so on. It also considers nodes that do not have any parallelization settings on their own. To specify a maximum parallelization degree p larger than the number of cores n existing on the host machine: Enable the maximum number of threads setting in the project category of the global settings. Set a suitable number in the Maximum number of threads project setting.	Y	[-1 : ∞] / -1
IM_OOPStartTimeout	OOP helper start timeout	Sets the timeout for helper processes used to connect to external software such as Python and Excel, in seconds.	N	[1 : ∞] / 150
IM_ProcessFileCheckInterval	Process file check interval	Sets the interval between checks for process output file existence, in seconds.	N	[1 : ∞] / 1
IM_ProcessDebugFileCheck	Process file check troubleshooting output	Turns troubleshooting output for process actor file checks on/off.	N	1 (True)
IM_ProjectHeartbeatNotificationDefaultIntervalSecond	Project heartbeat notification default interval (s)	Sets the default interval between project heartbeat notifications, in seconds.	N	[1 : ∞] / 10
IM_RenderMode	Render mode	Sets the render mode of 3D accelerated graphics.	Y	Auto-detect \| Force desktop OpenGL \| Force software OpenGL
IM_ApplicationStyle	UI style	Sets the style for the application.	Y	0
IM_ProjectDirAsDefaultFileChooserPath	Use project directory as default filechooser path	When selected, uses project directory as default path for file selectors.	N	1 (True)

Customization

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
SC_AlternativeCADirectories	Alternative customized algorithms directories	Sets the alternative search directories for optiSLang custom algorithms. Can be a single directory or a list of directories, separated by the appropriate separator (: on Windows platforms, ; on Linux platforms).	Y	N/A
SC_AlternativeCFADirectories	Alternative customized file access directories	Sets the alternative search directories for optiSLang custom file access. Can be a single directory or a list of directories, separated by the appropriate separator (: on Windows platforms, ; on Linux platforms).	Y	N/A
SC_AlternativeCIDirectories	Alternative customized integrations directories	Sets the alternative search directories for optiSLang custom integrations. Can be a single directory or a list of directories, separated by the appropriate separator (: on Windows platforms, ; on Linux platforms).	Y	N/A
SC_AlternativeCWDirectories	Alternative customized wizards directories	Sets the alternative search directories for optiSLang custom wizards. Can be a single directory or a list of directories, separated by the appropriate separator (: on Windows platforms, ; on Linux platforms).	Y	N/A
SC_AlternativePluginDirectories	Alternative plugin search directories	Sets the alternative search directories for optiSLang plugins. Can be a single directory or a list of directories, separated by the appropriate separator (: on Windows platforms, ; on Linux platforms).	Y	N/A
SC_ScriptsDirectory	Customized integrations script directory	Sets the search directory for customized integration scripts.	Y	N/A
IM_CustomIntegrationsTree	Customized integrations use treeview	When selected, uses tree view instead of list view in customized integrations.	N	1 (True)

Extraction Tool Kit (ETK)

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_FileContentCacheSizeMB	File content cache size	Sets the maximum cache size in MB for the file content cache of the ETK output extraction node.	N	[1 : ∞] / 500

Input Parametrization

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
ISC_DefaultFormatInt	Default integer format	Sets the default format string for integer values.	N	%8d
SC_DefaultFormatReal	Default real format	Sets the default format for real values.	N	%18.16lf
SC_DefaultFormatString	Default string format	Sets the default format for string values.	N	%s
SC_PredefinedFormatstrings	Predefined format strings	Sets the list of available format strings in text input dialog box format selection, separated by \|. When adding format strings in text input dialog box these are added to the list. The number of predefined strings is limited to the last 15 added format strings.	Y	%18.16lf\|

Integrations

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
SC_OdbApiSearchDirectories	Abaqus Libraries Search Directories	Sets the path to extracted ABAQUSlibraries directories.	N	N/A
IM_UseSystemPython	Allow use of system-installed Python for actors (Experimental)	Enables actor setting to optionally use the system's globally installed Python 2.7 instead of the optiSLang private version.	Y	0 (False)
SC_CalcDirectoryPath	LibreOffice Calc installation directory	Sets the LibreOffice Calc installation directory (only relevant for Linux platforms).	Y	N/A
SC_MatlabDirectoryPath	MATLAB installation directories	Sets the MATLAB installation directories (only relevant for Linux platforms). Multiple entries must be separated by a colon.	Y	C:\Program Files
SC_MatlabPredefinedVersions		Defines the MATLAB versions (only relevant for Windows platforms). Multiple entries must be separated by \|.	Y	8.1\|8.0\|7.14\|7.13\|7.12\|7.11\|7.10\|7.9\|7.8\|7.7
IM_ProjectDefaultShowConditionalExecUI	Show conditional execution tab	When selected, displays the Conditional Execution tab in an integration node.	N	0 (False)
IM_ProjectDefaultShowFilesUI	Show files tab	When selected, displays the Files tab in an integration node.	N	0 (False)
IM_ProjectDefaultShowPlaceholdersUI	Show placeholder tab	When selected, displays the Properties & Placeholders tab in an integration node.	N	0 (False)
IM_ProjectDefaultShowVariablesUI	Show variables tab	When selected, displays the Variables tab in an integration node.	N	1 (True)
SC_PredefinedFormatstrings	VCollab executable	Sets the path to VMoveCAEBatch.exe to be used by the VCollab node (only relevant for Windows platforms). If left empty, the VCollab node tries to detect the VCollab path.	Y	N/A

Licensing

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_ReturnLicensesAfterWorkflowTermination	Return licenses after workflow termination	Default for a project setting that controls the behavior of returning licenses of optiSLang and Ansys solvers in use, if any, after the workflow run is finished.	Y	0 (False)

Parameter Manager

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
FM_DefaultParameterRandomCOV	Default parameter COV	Sets the default coefficient of variation (COV) when creating stochastic parameters.	N	[0.0001 : 0.9999] / 0.1
CC_PM_PdfPlot	Parameter manager probability density function plot color	Sets the color of the probability density function plot (PDF) in parameter manager (only for stochastic parameters) split to the additive primaries of red, green and blue. For transparency effects you can define the alpha channel.	N	[250, 120, 0](255)
CC_PM_DomainPlot	Parameter manager range plot color	Sets the color of the range plot in parameter manager split to the additive primaries of red, green and blue. For transparency effects you can define the alpha channel.	N	[250, 120, 0](255)
FM_DefaultParameterBoundsAdjustmentMin	Range adjustment lower bound	Sets the default adjustment of the lower bound of the parameter range relative to the reference value when creating deterministic parameters.	N	[0.0001 : 0.9999] / 0.1
FM_DefaultParameterBoundsAdjustmentMax	Range adjustment upper bound	Sets the default adjustment of the upper bound of the parameter range relative to the reference value when creating deterministic parameters.	N	[0.0001 : 0.9999] / 0.1

Postprocessing

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_PreferClassicMonitoring	Prefer classic monitoring	When selected, uses classic monitoring if possible.	N	0 (False)

Project

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_GlobFileCmprLvl	Archive compression level	Sets the compression level that is used in file archiving tasks. Values in the range of 0 - 9 are allowed, where 0 means poor/fast and 9 strong/slow compression.	N	[0 : 9] / 3
IM_AutomatchDefaultBehavior	Default file relocation behavior	Sets the default behavior for relocation of missing files when loading projects. Available options are: 0: Ask user for desired behavior; 1: Always auto-relocate; 2: Always show advanced options; 3: Never relocate.	N	0 (Ask user for desired behavior)
IM_AutorelocateMaximumDepth	Default maximum auto-relocation depth	Defines the default maximum search depth for automatic file-relocation.	N	[0 : ∞] / 3
SC_DefaultPurgeFilter	Default wildcard filter for purging	Sets the default wildcard filter used for purging a project.	N	".omdb" ".bin"
IM_ProjectDefaultIgnorePredecessorFailure	New projects default to 'Continue execution if a predecessor did not run'	When selected, new projects have their continuation mode initially set to Continue execution if a predecessor did not run.	N	1 (True)
IM_ProtocolFileFlushInterval	Protocol file write interval (ms)	Sets the interval for writing the project protocol file (in milliseconds).	N	1000
SC_ProjectTemp	Temporary directory	Overrides the location of the temporary directory for optiSLang projects.	Y	N/A
IM_MaxStartDesignsFotPlaceholderSupport	Maximum start designs for placeholdering	Limits the maximum number of start designs supported for external/global editing (via "Project Overview" dialog) and for placeholdering. If the number of designs is higher, then the "StartDesigns" property of the corresponding system will not be displayed in the node property tree in the "Project Overview" dialog. Exception: If a placeholder is already assigned to the "StartDesigns" property, it will always be displayed. The limit is intended to workaround UI performance issues with very high numbers of start designs.	N	Default value: 100

Result Monitoring

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_ResultDesignTableUpdateIntervalMilliseconds	Design table update interval (ms)	Sets the update interval of design tables during the run, in milliseconds.	Y	[100 : ∞] / 3000
IM_ResultDesignTableMaxDesigns	Maximum designs shown in result design table	Limits the maximum number of designs shown in the "Result designs" tabs of Parametric/Algorithm system dialogs. If the number of designs is higher, then the tab will not display designs. The limit is intended to workaround UI performance issues with very high numbers of result designs.	N	Default value: 300,000

Configuration File ID

Attribute

Description

Needs Restart

[Range] / Default Value

IM_ResultDesignTableUpdateIntervalMilliseconds

Design table update interval (ms)

Sets the update interval of design tables during the run, in milliseconds.

[100 : ∞] / 3000

IM_ResultDesignTableMaxDesigns

Maximum designs shown in result design table

Limits the maximum number of designs shown in the "Result designs" tabs of Parametric/Algorithm system dialogs.

If the number of designs is higher, then the tab will not display designs.

The limit is intended to workaround UI performance issues with very high numbers of result designs.

Default value: 300,000

Scenery

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_DisableSceneAnimations	Disable scenery animations	Controls whether scenery animations are enabled or disabled. Possible values are: 0: Auto-detect (optiSLang tries to detect remote display connections, in which case animations are disabled); 1: Never disable; 2: Always disable.	N	0 (Auto-detect)
FM_SceneNodePreviewSizeY	Monitoring height (px)	Sets the height of the in-scene monitoring panel, in pixels.	Y	[32 : 2048] / 300
IM_SceneNodePreviewTimeout	Monitoring hover timeout (ms)	Sets the time to show the monitoring preview when hovered before closing in milliseconds.	N	[0 : ∞] / 1000
FM_SceneNodePreviewSizeX	Monitoring width (px)	Sets the width of the in-scene monitoring panel, in pixels.	Y	[32 : 2048] / 300
IM_SceneNodeSize	Node size (px)	Sets the size of the nodes in the Scenery pane, in pixels.	Y	[20 : 100] / 40
FM_SceneGridSize	Scenery grid size (px)	Sets the grid size for node positioning and moving, in pixels.	N	[1 : 100] / 10
IM_SceneSizeY	Scenery height (px)	Sets the height of the Scenery pane, in pixels.	Y	[512 : 65536] / 8192
IM_SceneSizeX	Scenery width (px)	Sets the width of the Scenery pane, in pixels.	Y	[512 : 65536] / 8192
IM_ScenerySlotViewMode	Slot flyout view mode	Sets how the input/output slots are displayed in node flyouts.	N	[0, 1] / 0
FM_SubSystemOpacity	Subsystem opacity	Sets the opacity of the subsystems in the Scenery pane.	N	[0.1 : 1.0] / 0.6

Table/Tree Views

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_StringConversionPrecisionDisplayMode	Display mode floating point precision	Sets the precision for displaying float values in all Result Designs tables.	Y	[-1 : 32] / -1
IM_StringConversionPrecisionDisplayModeFormat	Display mode floating point format	Sets the format for displaying float values to one of the following in all Result Designs tables : Default (%g) Fixed floating point (%f) Exponential (%e)	Y	Default / Fixed floating point / Exponential
CC_LogError	Error message color	Sets the background color of error log messages split to the additive primaries of red, green and blue. For transparency effects you can define the alpha channel.	N	[255, 204, 204](255)
CC_LogWarning	Warning message color	Sets the background color of warning log messages split to the additive primaries of red, green and blue. For transparency effects you can define the alpha channel.	N	[255, 255, 204](255

Toolboxes (Panes)

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
FM_FloatingToolboxAlpha	Floating opacity	Sets the opacity of panes (for example, the Modules pane) when floating around. Possible values range from >0.0 (barely visible) to 1.0 (fully opaque).	Y	[0.01 : 10] / 1.0
FM_FloatingToolboxAlphaHover	Floating opacity when hovered	Sets the opacity of panes when the mouse is inside. Same value range as the Floating opacity setting. Using an opacity value lower than the Floating opacity setting has no effect.	Y	[0 : 1.0] / 1.0
IM_ModuleBoxIconSize	Icon size	Sets the size of the icons within panes, in pixels.	Y	[16 : 64] / 20
IM_BetaModules	Show beta modules	When selected, displays the beta modules in the Modules pane.	Y	0 (False)

Wizards

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_WizardMethodSettingsShowAlways	Always show methods selection criteria	When selected, always show the methods selection criteria even if nothing can be changed.	N	0 (False)
IM_WizardCreateTemplateDefault	Create template by default	When selected, create templates of the parametric system after Solver wizard finishes.	N	0 (False)
IM_WizardDefaultHeight	Default height (px)	Sets the default height of the wizard dialog box, in pixels.	N	[400 : 2048] / 800
IM_WizardDefaultWidth	Default width (px)	Sets the default width of the wizard dialog box, in pixels.	N	[400 : 2048] / 1000
IM_WizardAutoLayout	Perform Auto-Layout after wizard	When selected, automatically lays out the items in the Scenery pane after the wizard finishes.	N	1 (True)
IM_WizardAlgorithmShowSDI	Show algorithm SDI	When selected, displays the Stochastic Design Improvement algorithm in the Optimization wizard.	N	0 (False)
IM_WizardAlgorithmShowCE	Show algorithm complexity evaluation	When selected, displays the panel for complexity (runtime) evaluation in algorithm wizards.	N	0 (False)
IM_WizardAlgorithmSettingsShow	Show algorithm settings	When selected, displays advanced algorithm settings page in wizards.	N	0 (False)
IM_WizardCreateTemplateShow	Show create template option	When selected, displays the Create Template option in the Solver wizard.	N	1 (True)
SC_WizardTemplatesDirectory	Solver wizard templates directory	Sets the directory for solver-dependent script templates used for the Solver wizard.	N	N/A

optiSLang Web Service

Configuration File ID	Attribute	Description	Needs Restart	[Range] / Default Value
IM_OWS_OAuthRedirectPort	OAuth2 Authorization Code Flow redirect port	Sets the port of the Authorization Code Flow redirect listener. Must match the port of the redirect address set up for optiSLang in the client configuration of the Identity Provider.	N	1234
SC_OWS_OAuthScopes	OAuth2 Scopes	Sets the scopes to be requested during authentication/authorization.	N	openid profile roles
SC_OWS_OAuthTokenClaim_PreferredUsername	OAuth2 access token claim: Preferred user name	Sets the access token name containing the preferred user name.	N	preferred_username
IM_OWS_OAuthPercentEncodeAccessCode	Percent encode OAuth2 authorization code	When selected, applies percent encoding to the authorization code.	N	0 (False)
IM_OWS_OAuthUseSystemDefaultBrowser	Use system default browser for authentication	When selected, uses the system default browser instead of the built-in optiSLang browser for OAuth Authentication Code Flow authentication.	N	0 (False)

Python Locations

You can define additional locations of Python environments in the optiSLang.ini configuration file [Python Locations] section to use them in the Script node, Python node or in the configuration of custom script interfaces. For example:

    [Python Locations]
    id_for_py_27=/path/to/python-2.7
    id_for_py_35=/path/to/python-3.5
    id_for_py_36=/path/to/python-3.6
    id_for_py_37=/path/to/python-3.7

Note the following:

You must create the [Python Locations] section manually if it does not already exist.
You can find the registration messages in the Application log.
The Python node and the Custom Integration nodes need a shared library (*.dll, *.so) so they only support 64 bit Python.
The Script node needs an executable (*.exe) and supports both 64 bit and 32 bit Python.