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

From Slicer Wiki
Jump to: navigation, search
(moved extensions index documentation to readthedocs)
Tags: 2017 source edit, Replaced
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
={{#titleparts: {{PAGENAME}} | | -1 }}=</noinclude><includeonly>
='''User FAQ: {{{1}}}'''=
== What is an extension ? ==
== What is the extensions catalog ? ==
== Why there are no windows 32-bit extensions available ?==
| 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 users 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 [here].
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, it is currently not possible without uninstalling the extension and re-installing it.
We are currently developing a mechanism allowing to either manually update or automatically suggest update. In the process of finalizing, reviewing and testing, the corresponding feature will be available in Slicer {{documentation/nextversion}}.
For more details, see [1][2] and [3]
[1] http://na-mic.org/Mantis/view.php?id=2089
[2] https://github.com/mwoehlke-kitware/Slicer/tree/REBASE-2089-update-extensions
[3] http://wiki.slicer.org/slicerWiki/index.php/Documentation/Labs/ExtensionsFrameworkRoadmap
== How to manually install an extension ? ==
1) Get revision associated with your install or built Slicer. (Menu -> Help -> About)
2) Download extension matching your Slicer revision. Select operating system, bitness and enter revision on http://slicer.kitware.com/midas3/slicerappstore
3) Extract the archive (zip or tar.gz) in a folder. You should then have a folder like:
containing folder like:
For more details: [[Documentation/{{documentation/version}}/Developers/DirectoryStructure]]
4) In the Module settings (Menu -> Edit -> Settings), add the path ending with <code>lib/Slicer-X.Y/{cli|qt-scripted|qt-loadable}-modules</code>
== How do I associate a remote with my local extension git source directory ? ==
1) Start a terminal (or Git Bash on Windows)
2) Get the associated SSH remote url. [https://help.github.com/articles/which-remote-url-should-i-use#cloning-with-ssh Need help ?]
3) Associate the remote URL with your local git source tree
git remote add origin git://github.com/<username>/MyExtension
== Which remote name is expected for extension git checkout ? ==
When packaging an extension and generating the associated [[Documentation/{{documentation/version}}/Developers/Extensions/DescriptionFile|description file]], the system will look for a remote named <code>origin</code>.
In case you get the error reported below, you will have to either rename or add a remote. [http://git-scm.com/book/en/Git-Basics-Working-with-Remotes Need help ?]
CMake Warning at /path/to/Slicer/CMake/FindGit.cmake:144 (message):
No remote origin set for git repository: /path/to/MyExtension
Call Stack (most recent call first):
/path/to/Slicer/CMake/SlicerMacroExtractRepositoryInfo.cmake:99 (GIT_WC_INFO)
/path/to/Slicer/CMake/SlicerExtensionCPack.cmake:55 (SlicerMacroExtractRepositoryInfo)
CMakeLists.txt:25 (include)

Latest revision as of 01:05, 23 March 2021

Home < Documentation < Nightly < FAQ < Extensions

For the stable Slicer documentation, visit the 4.10 page.

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