Difference between revisions of "Documentation/Nightly/SlicerApplication/ApplicationSettings"

From Slicer Wiki
Jump to: navigation, search
(Replaced content with "<noinclude>{{documentation/versioncheck}}</noinclude> {{documentation/banner | text = [https://slicer.readthedocs.io/en/latest/user_guide/settings.html This page has bee...")
Tags: 2017 source edit, Replaced
 
Line 1: Line 1:
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<noinclude>{{documentation/versioncheck}}</noinclude>
=Overview=
 
  
The application setting dialog will allow the user to customize application behavior.
+
{{documentation/banner
 
+
| text  = [https://slicer.readthedocs.io/en/latest/user_guide/settings.html This page has been moved to read-the-docs.]
After starting Slicer, it can be accessed clicking on menu <code>Edit -> Application Settings</code>
+
| background-color = 8FBC8F }}
 
 
=Panels=
 
==General==
 
{|
 
|
 
|valign="top"|[[Image:GeneralSettings.png|thumb|400px|General settings panel]]
 
|}
 
==Modules==
 
{|
 
|
 
===Skip Loading of===
 
Select which [[Documentation/{{documentation/version}}/Developers/Modules|type of modules]] to not load at startup. It is also possible to start slicer by temporarily disabling those modules (not saved in settings) by passing the arguments in the command line.
 
 
 
For example <code>$ .\Slicer.exe --disable-cli-modules</code> will start Slicer without any CLI loaded.
 
 
 
===Prefer Executable CLIs===
 
Use the executable version of a CLI instead of its shared version. CLI modules typically come in 2 forms, as shared (dll)and as executable (exe). By default, if there is a shared version, it is the one loaded by Slicer, ignoring the executable version. Loading a shared runs the module faster but increases the memory consumption. For some configurations (e.g. Windows 32b), memory is critical. Toggling this option to ON skips the loading of shared CLIs and loads executable version of CLIs instead. If there is no executable for a given CLI, the shared version is used.
 
 
 
===Show hidden modules===
 
Some modules don't have a user interface, they are hidden from the module's list. For debugging purpose, it is possible to force their display
 
 
 
===Temporary directory===
 
Directory where modules can store their temporary outputs if needed.
 
 
 
===Additional module paths===
 
List of directories scanned at startup to load additional modules. Any CLI, Loadable or scripted modules located in these paths will be loaded. Extensions are listed in the list, to remove an extension, use the [[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager|Extension Manager]] instead.
 
 
 
It is also possible to start slicer by temporarily adding module paths (not saved in settings) by passing the arguments in the command line.  
 
 
 
For example <code>$ .\Slicer.exe --additional-module-paths C:\path\to\lib\Slicer-X.Y\cli-modules</code> will start Slicer trying to load CLIs found in the specified directory.
 
 
 
===Modules===
 
List of modules loaded, ignored or failed to load in Slicer. An unchecked checkbox indicates that module should not be loaded (ignored) next time Slicer starts. A text color code is used to describe the state of each module:
 
** Black: module successfully loaded in Slicer
 
** Gray: module not loaded because it has been ignored (unchecked)
 
** Red: module failed to load. There are multiple reasons why a module can fail to load. Look at startup [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog|log outputs]] to have more informations.
 
If a module is not loaded in Slicer (ignored or failed), all dependent modules won't be loaded. You can verify the dependencies of a module in the tooltip of the module.
 
 
 
You can filter the list of modules by untoggling in the advanced (>>) panel the "To Load", "To Ignore", "Loaded", "Ignored" and "Failed" buttons.
 
 
 
===Home===
 
Module that is shown when Slicer starts up.
 
 
 
===Favorites===
 
List of modules that appear in the Favorites toolbar.
 
[[Image:FavoritesToolbar.png|Favorites toolbar]]
 
To add a module, drag&drop it from the ''Modules'' list above. Then use the advanced panel (>>) to reorganize/delete the modules within the toolbar.
 
|valign="top"|[[Image:ModulesSettings.png|thumb|400px|Modules settings panel]]
 
|}
 
==Extensions==
 
{|
 
|
 
|valign="top"|[[Image:ExtensionsSettings.png|thumb|400px|Extensions settings panel]]
 
|}
 
==Cache==
 
{|
 
|
 
|valign="top"|[[Image:CacheSettings.png|thumb|400px|Cache settings panel]]
 
|}
 
==Python==
 
{|
 
|
 
|valign="top"|[[Image:PythonSettings.png|thumb|400px|Python settings panel]]
 
|}
 
==Units==
 
{|
 
|
 
|valign="top"|[[Image:UnitsSettings.png|thumb|400px|Units settins panel]]
 
|}
 
 
 
==Volume Rendering==
 
{|
 
|
 
|valign="top"|[[Image:VolumeRenderingSettings.png|thumb|400px|Volume Rendering settings panel]]
 
|}
 
== Others ==
 
Extensions can also add their own settings panel.
 
 
 
= Information for Advanced Users =
 
 
 
== Settings file location ==
 
 
 
Settings are stored in a *.ini files located in directory like these ones:
 
 
 
* Windows: <tt>%USERPROFILE%\AppData\Roaming\NA-MIC\</tt> (typically <tt>C:\Users\<your_user_name>\AppData\Roaming\NA-MIC\</tt>)
 
* Linux: <tt>~/.config/NA-MIC/</tt>
 
* Mac: <tt>~/.config/www.na-mic.org/</tt>
 
 
 
Deleting the *.ini files restores all the settings to default.
 
 
 
 
 
There are two types of settings:
 
 
 
 
 
<b>User specific settings:</b>
 
 
 
This file is named '''Slicer.ini''' and it stores settings applying to '''all version''' of Slicer installed by the '''current user'''.
 
 
 
To display the exact location of this settings file, open a terminal and type:
 
$ ./Slicer --settings-path
 
 
 
or enter the following in the python interactor:
 
 
 
>>> slicer.app.slicerUserSettingsFilePath
 
 
 
<b>User and revision specific settings:</b>
 
 
 
This file is named like '''Slicer-<REVISION>.ini''' and it stores settings applying to a '''specific revision''' of Slicer installed by the '''current user'''.
 
 
 
To display the exact location of this settings file, enter the following in the python interactor:
 
 
 
>>> slicer.app.slicerRevisionUserSettingsFilePath
 

Latest revision as of 00:40, 23 May 2020

Home < Documentation < Nightly < SlicerApplication < ApplicationSettings

For the stable Slicer documentation, visit the 4.10 page.

This page has been moved to read-the-docs.