Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions

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 easily create an extension containing one or more Slicer modules.

   For example, you could create an extension bundling one Command line module:

   Linux or MacOSX

   Windows

   Start a terminal. $ cd Slicer $ ../Slicer-SuperBuild/python-build/bin/python ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate/ --target ~/MyExtension MyExtension $ rm -rf /home/jchris/MyExtension/CLIModuleTemplate/ $ ../Slicer-SuperBuild/python-build/bin/python ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate/CLIModuleTemplate/ --target ~/Projects/MyExtension/MyCLI MyCLI $ sed -i.bak 's/add_subdirectory(CLIModuleTemplate)/add_subdirectory(MyCLI)/g' ~/MyExtension/CMakeLists.txt && rm ~/MyExtension/CMakeLists.txt.bak

   Start Git Bash (not the Windows command line). Need help ? $ cd Slicer $ ../Slicer-SuperBuild/python-build/bin/Release/python.exe ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate/ --target ~/MyExtension MyExtension $ rm -rf /home/jchris/MyExtension/CLIModuleTemplate/ $ ../Slicer-SuperBuild/python-build/bin/Release/python.exe ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate/CLIModuleTemplate/ --target ~/Projects/MyExtension/MyCLI MyCLI $ sed.exe -i.bak 's/add_subdirectory(CLIModuleTemplate)/add_subdirectory(MyCLI)/g' ~/MyExtension/CMakeLists.txt && rm ~/MyExtension/CMakeLists.txt.bak

5. Create a repository to save your work. We recommend GitHub

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

7. Create a documentation page for your extension.

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

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

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

    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	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).

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

12. 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.

13. If you consider your extension ready for distribution, follow these instructions. to contribute the already generated description file.