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
 
(18 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<noinclude>{{documentation/versioncheck}}</noinclude>
<noinclude>__TOC__
 
={{#titleparts: {{PAGENAME}} | | -1 }}=</noinclude><includeonly>
 
='''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 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
 
 
 
== 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:
 
 
 
/path/to/<slicer_revision>-<os>-<bitness>-<extension_name>-<extension_scm><extension_revision>-YYYY-MM-DD
 
 
 
containing folder like:
 
 
 
lib/Slicer-X.Y/cli-modules
 
lib/Slicer-X.Y/qt-loadable-modules
 
lib/Slicer-X.Y/qt-scripted-modules
 
 
 
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
 
 
 
<pre>
 
git remote add origin git://github.com/<username>/MyExtension
 
</pre>
 
 
 
== 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 ?]
 
 
 
<pre>
 
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)
 
</pre>
 

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.