Difference between revisions of "Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions"
m |
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887) |
||
Line 1: | Line 1: | ||
+ | <noinclude>{{documentation/versioncheck}}</noinclude> | ||
== Step-by-step: How to create, publish and distribute an extension ? == | == Step-by-step: How to create, publish and distribute an extension ? == | ||
Revision as of 08:02, 14 June 2013
Home < Documentation < Nightly < Developers < Tutorials < BuildTestPackageDistributeExtensions
For the latest Slicer documentation, visit the read-the-docs. |
Step-by-step: How to create, publish and distribute an extension ?
(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.
Build Slicer application in
Release
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
Create a repository to save your work. We recommend GitHub
Implement your extension.
Hack, hack, hack :)
. Make sure to commit often using meaningful commit message.If not already done, send an email on the slicer developers list asking to be granted write permission on the experimental folder.
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.Assuming the source code of your extension is located in folder
MyExtension
, you could upload your extension doing:Check submission results on the dashboard: http://slicer.cdash.org/index.php?project=Slicer4#Extensions-Experimental
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.If you consider your extension ready for distribution, follow these instructions. to contribute the already generated description file.