Documentation/Nightly/SlicerApplication/ExtensionsManager

For the latest Slicer documentation, visit the read-the-docs.

3D Slicer now supports plug-ins which we call extensions. Extensions are available from an extension server. This allows end-users to select the extensions useful to them, without having to download the entire extension archive.

Extensions Manager

Prerequisites

ExtensionsManager must be enabled in the Application Settings (menu item "Edit -> Application Settings -> Extensions"). If you changed the setting, Slicer has to be restarted for it to become effective.

Installing an extension

• 

  1. Open extensions manager

• 

  2. Choose an extension

• 

  3. Look at extension details

• 

  4. Click on "Install"

• 

  5. Extension is installed

• 

  6. Restart Slicer

• 

  7. Extension is available

Installing an extension without network connection

• 

  1. Open extensions manager

• TBD

  2. Select 'Install from File' from the tools menu

• TBD

  3. Select a previously downloaded or othwerwise obtained extension archive

• TBD

  4. Extension is installed

• TBD

  5. Restart Slicer

• 

  6. Extension is available

Uninstalling an extension

• 

  1. Open extensions manager

• 

  2. Click on "Uninstall"

• 

  3. Extension is scheduled for uninstall

• 

  4. Restart Slicer

• 

  5. Extension has been uninstalled

Disabling an extension

• 

  1. Open extensions manager

• 

  2. Disable extension

• 

  3. Restart Slicer

Incompatible extensions

Caveat: Considering that installed extensions are common to all Slicer version installed by a given user and that an extension is specific to a given revision of Slicer, it's currently not possible to have working extension installed for multiple version of Slicer. The issues has been reported as #1958 and is currently targeted for 4.2.0 release.

• 

  Incompatible extension has been identified

• 

  Error log message

Extensions Manager Settings

Extensions settings

Extensions settings

Extensions server URL: Address of the server used to download and install extensions Extensions installation path: Directory where extension packages should be extracted and installed

Module settings

Module settings

After installing an extension, the directories containing the modules bundled within an extension will be visible as additional module paths. Modules associated with an extension can also be disabled one by one.

Launcher settings

Launcher settings

Whereas the module path is used to indicate Slicer where to look to load additional modules, the extension manager also takes care of updating the LibraryPaths / Paths / EnvironmentVariables in the launcher settings so that libraries associated with modules can be successfully loaded.

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