Difference between revisions of "Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions"

From Slicer Wiki
Jump to: navigation, search
m
Line 9: Line 9:
 
<li><p>[[Documentation/{{documentation/version}}/Developers/Build_Instructions|Build Slicer application]] in <code>Release</code></p></li>
 
<li><p>[[Documentation/{{documentation/version}}/Developers/Build_Instructions|Build Slicer application]] in <code>Release</code></p></li>
  
−
<li><p>[[Documentation/{{documentation/version}}/Developers/ModuleWizard|Use the Wizard to easily create an extension]] containing one or more Slicer modules.</p></li>
+
<li><p>[[Documentation/{{documentation/version}}/Developers/ModuleWizard|Use the Wizard to easily create an extension]] containing one or more Slicer modules.</p>
 +
 
 +
{|width = "100%"
 +
! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Unix-like
 +
! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Windows
 +
|-
 +
| valign="top" |
 +
{{pre2|<nowiki>
 +
$ 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
 +
</nowiki>}}
 +
 
 +
| valign="top" |
 +
ff
 +
|}
 +
</li>
  
 
<li><p>Create a repository to save your work. We recommend [https://github.com/ GitHub]</p></li>
 
<li><p>Create a repository to save your work. We recommend [https://github.com/ GitHub]</p></li>
Line 35: Line 54:
 
$ 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
 
$ 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</nowiki>
+
$ make ExperimentalUpload
−
}}
+
</nowiki>}}
 
| valign="top" |
 
| valign="top" |
 
<ol start="1" style="list-style-type: decimal;">
 
<ol start="1" style="list-style-type: decimal;">

Revision as of 13:11, 13 June 2013

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

    Unix-like Windows 
    $ 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

    ff

  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:

    Makefile 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
    1. Start CMake, select source and build directory
    2. Add Slicer_DIR, MIDAS_PACKAGE_EMAIL and MIDAS_PACKAGE_API_KEY entries to the cache
      3. Slicer Extensions Configure Windows.png
    3. Click on Configure, select Generator, then click on Generate button.
    4. Open MyExtension.sln (1), select Release configuration (2), select ExperimentalUpload (3) and Build (4).
      5. Slicer Extension ExperimentalUpload Windows VS2008.png

  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.


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions&oldid=32052"