Difference between revisions of "Documentation/Nightly/FAQ/Extensions"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
(moved extensions index documentation to readthedocs)
Tags: 2017 source edit, Replaced
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<noinclude>{{documentation/versioncheck}}</noinclude>
<noinclude>__TOC__
 
={{#titleparts: {{PAGENAME}} | | -1 }}=</noinclude><includeonly>
 
{{#ifeq: {{#titleparts: {{PAGENAME}} | 3 }} | Documentation/{{documentation/version}}/Developers | | ='''User FAQ: {{{1}}}'''=}}
 
</includeonly>
 
== What is an extension ? ==
 
{{:Documentation/{{documentation/version}}/Extensions/Description}}
 
== What is the extensions catalog ? ==
 
{{:Documentation/{{documentation/version}}/Extensions/Catalog}}
 
  
== Why there are no windows 32-bit extensions available ?==
+
{{documentation/banner
 
+
| text = [https://slicer.readthedocs.io/en/latest/user_guide/extensions_manager.html This page has been moved to read-the-docs.]
* Win 32 has a very limited amount of memory available to an application.
+
| background-color = 8FBC8F }}
* Many registration and segmentation algorithms fail on that platform because they run out of memory, when used with state of large data.
 
* Some of these failures are just that, some can crash slicer. Even though the "real" failure is  caused by overextending the capabilities of the hardware (in a way the user's fault), it appears to the user that Slicer does not work.
 
* If you search the archives of Slicer Users there are several such complaints until we started to discourage people to use 32 bit.
 
 
 
Discussion: http://massmail.spl.harvard.edu/public-archives/slicer-users/2013/006703.html
 
 
 
== Should I install the nightly version to access to last extension updates ? ==
 
 
 
If the extension developers contributed updates for the current stable release, you don't have to install the nightly version of Slicer. You can simply update the extension. Consider reading [[#How_to_update_an_already_installed_extension.3F|How to update an already installed extension]].
 
 
 
On the other hand, if the extension developers stopped to maintain the version of their extension built against the stable release (so that we can use the latest feature that will be in the next Slicer release), downloading the nightly is the only way to get the latest version of the extension.
 
 
 
== How to update an already installed extension? ==
 
 
 
Assuming updates extensions are available for your version of Slicer, extensions can either be updated manually or automatically.
 
 
 
See [[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager#Updating_installed_extensions|Updating installed extensions]]
 
 
 
== How to manually download an extension package? ==
 
 
 
1) Get revision associated with your install or built Slicer (Menu -> Help -> About). The revision is a number preceded by ''r'' character, for example: if the complete version string is ''4.3.1-2014-09-14 r23677'' the revision is ''23677''
 
 
 
2) Open the extension catalog (app store). The default Slicer extension catalog is available at: http://slicer.kitware.com/midas3/slicerappstore
 
 
 
3) Select operating system, bitness and enter revision in the empty textbox between the bitness selector and the searchbox. If no revision is entered then the ''No extensions found'' message will be displayed.
 
 
 
4) Click ''Download'' button of the selected extension to download the extension package.
 
 
 
== How to manually install an extension package? ==
 
 
 
Option 1. Use extension manager as described [[#Installing_an_extension_without_network_connection|above]]
 
 
 
Option 2. Use Slicer extension called "DeveloperToolsForExtensions"
 
 
 
Option 3. Fully manual installation:
 
 
 
* Extract the archive (zip or tar.gz) in a folder. You should then have a folder like:
 
 
 
    /path/to/<slicer_revision>-<os>-<bitness>-<extension_name>-<extension_scm><extension_revision>-YYYY-MM-DD
 
 
 
containing one or more of the following folders (for more information on folder structure, click [[Documentation/{{documentation/version}}/Developers/DirectoryStructure|here]]):
 
 
 
    lib/Slicer-X.Y/cli-modules
 
    lib/Slicer-X.Y/qt-loadable-modules
 
    lib/Slicer-X.Y/qt-scripted-modules
 
 
 
* In the Module settings (Menu -> Edit -> Settings), add all existing paths ending with:
 
 
 
lib/Slicer-X.Y/cli-modules
 
  lib/Slicer-X.Y/qt-loadable-modules
 
lib/Slicer-X.Y/qt-scripted-modules
 
 
 
Note: additional module paths can be added temporarily by starting Slicer with the option <code>--additional-module-paths</code>.
 
 
 
== How to create a custom Slicer version with selected extensions pre-installed? ==
 
 
 
1) Download and install Slicer
 
 
 
2) Install all necessary extensions manually (as described above) in <slicer_install_dir>/lib/Slicer-X.Y/...
 
 
 
3) If all the files in <slicer_install_dir> are copied to any other folder/computer/USB drive/portable storage device then Slicer can be launched by running the Slicer executable in the main directory. No installation or administrative access rights are necessary. Slicer can even be launched directly from a USB drive, without copying files to the computer.
 
 
 
== How to configure network proxy ? ==
 
 
 
System proxy is expected to be automatically used for downloading extensions. For more details, see [https://doc.qt.io/qt-5/qnetworkproxyfactory.html#setUseSystemConfiguration here]
 
 
 
== Troubleshooting missing extensions ==
 
 
 
Occasionally, expected extensions may be missing from the extension manager
 
 
 
=== Missing extensions for the stable release ===
 
 
 
If an extension you are looking for is missing from the extension manager for the stable release, please post on [https://discourse.slicer.org Discourse] to ask about the current status of the extension
 
 
 
=== Missing extensions for the nightly preview ===
 
 
 
Due to the constantly updating nature of the preview release, extensions may be missing at times:
 
 
 
* Early morning:  Typically, the full set of overnight builds will not be available before 9 am EST
 
* Factory system errors:  Occasionally, issues with the factory system will prevent some or all extensions from building. See '''Factory extensions status''' below
 
* Extension build errors: If the above situations are not applicable, the extension itself may have a build error, please post on [https://discourse.slicer.org Discourse] to ask about the current status of the extension
 
 
 
=== Factory extensions status ===
 
 
 
The current status of the Extension Manager is:  '''Good'''
 
 
 
Extensions are being built as expected.  When there are persistent issues with the extensions, this space will contain a link to the last preview installer with the full extension set.
 

Latest revision as of 01:05, 23 March 2021

Home < Documentation < Nightly < FAQ < Extensions