Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions

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

To learn what is an extension, see here

Conventions

• Terminal command - Block like the one below indicates that the command should be executed in a terminal.

1. On Windows, Git Bash is expected (not the Windows command line). Need help ?

$ echo "This is a command"

Step-by-step: How to create, publish and distribute an extension ?

1. Scan through the user and developer extension FAQs

2. (Optionally) Present your extension(s) on the slicer developers list to check if other developer are working on a similar project, to seek for advice or to reach out for potential collaborator.

3. Build Slicer application in Release

4. Use the Wizard to create an extension bundling one Command line module:

   $ cd Slicer-SuperBuild/Slicer-build
   
   $ bin/slicerExtensionWizard --create Slicer-MyExtension --addModule cli:MyCLI ~
   

   1. By specifying ~ as destination, the extension will be created into your home directory.
   2. Read our FAQ to learn about extension naming convention.

   To learn more about:

   the ExtensionWizard capabilities, click here.

   the different type of modules, click here.

5. If not already done, join Github and setup Git

6. Save the source code of your extension by publishing it on Github

   $ bin/slicerExtensionWizard --publish ~/Slicer-MyExtension/

7. Implement your extension. Hack, hack, hack :). Make sure to commit often using meaningful commit message.

8. Create a documentation page for your extension.

9. Create an account on the extension server and obtain an API Key. You will then use your midas login and api key to substitute <YOUR-MIDAS-LOGIN> and <YOUR-MIDAS-APIKEY> in the examples.

10. If not already done, go to NA-MIC community and click on Join community

11. If not already done, send an email on the slicer developers list asking to be granted write permission on the experimental folder.

    To: slicer-devel@bwh.harvard.edu
    Subject: Extension NAME-OF-YOUR-EXTENSION - Asking permission to write to the Experimental folder
    Hi, 
    
    This extension will allow to [...]
    
    Could you grant user YourUserName write access to the Experimental folder ?
    
    

12. Assuming the source code of your extension is located in folder MyExtension, you could upload your extension doing:

    1. To avoid typing the API email and key, you can set the environment variables MIDAS_PACKAGE_EMAIL and MIDAS_PACKAGE_API_KEY. More details here

    Linux or MacOSX (Makefile)

    Windows (Visual Studio)

    $ mkdir MyExtension-build $ cd MyExtension-build $ cmake -DCMAKE_BUILD_TYPE:STRING=Release -DMIDAS_PACKAGE_EMAIL:STRING=<YOUR-MIDAS-LOGIN> -DMIDAS_PACKAGE_API_KEY:STRING=<YOUR-MIDAS-APIKEY> -DSlicer_DIR:PATH=/path/to/Slicer-Superbuild/Slicer-build ../MyExtension $ make ExperimentalUpload MaxOSX: Extension must be configured specifying CMAKE_OSX_* variables matching the one used to configure Slicer: -DCMAKE_OSX_ARCHITECTURES:STRING=x86_64 -DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=/same/as/Slicer -DCMAKE_OSX_SYSROOT:PATH=SameAsSlicer

    Start CMake, select source and build directory Add Slicer_DIR, MIDAS_PACKAGE_EMAIL and MIDAS_PACKAGE_API_KEY entries to the cache Click on Configure, select Generator, then click on Generate button. Open MyExtension.sln (1), select Release configuration (2), select ExperimentalUpload (3) and Build (4).

13. Check submission results on the dashboard: http://slicer.cdash.org/index.php?project=Slicer4#Extensions-Experimental

    1. You should expect the test MyCLITest to fail with error of the form:

       [nrrd] nrrdIoStateDataFileIterNext: couldn't open "~/MyExtension-build/MyCLI/Data/Baseline/CLIModuleTemplateTest.raw"

       This is explained by the fact the *.nhdr file available on midas and downloaded locally still reference CLIModuleTemplateTest.raw

14. Check that the extension can be installed by starting the Slicer executable from /path/to/Slicer-Superbuild/Slicer-build and installing your extension as explained here.

15. If you consider your extension is ready for distribution, contribute it to the ExtensionsIndex:

    $ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/

    1. To contribute an extensions build against Slicer 4.10. See here.
    2. To learn about extension description file format. See here