|
Tags: 2017 source edit, Replaced |
| (21 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| | <noinclude>{{documentation/versioncheck}}</noinclude> | | <noinclude>{{documentation/versioncheck}}</noinclude> |
| | | | |
| − | To learn what is an extension, see [[Documentation/Nightly/Developers/FAQ#What_is_an_extension_.3F|here]]
| + | {{documentation/banner |
| − | | + | | text = [https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html This page has been moved to read-the-docs.] |
| − | == Conventions ==
| + | | background-color = 8FBC8F }} |
| − | | |
| − | * Terminal command - Block like the one below indicates that the command should be executed in a terminal.
| |
| − | | |
| − | <ol style="list-style-type:none; border-left:thick solid darkgreen; padding-left:1em;">
| |
| − | <li>On '''Windows''', Git Bash is expected (not the Windows command line). [https://help.github.com/articles/set-up-git#platform-windows Need help ?]</li>
| |
| − | </ol>
| |
| − | | |
| − | {{pre2|<nowiki>$ echo "This is a command"</nowiki>}}
| |
| − | | |
| − | | |
| − | == Step-by-step: How to create, publish and distribute an extension ? ==
| |
| − | | |
| − | <ol start="1" style="list-style-type: decimal;">
| |
| − | | |
| − | <li><p>Scan through the [[Documentation/{{documentation/version}}/FAQ/Extensions|user]] and [[Documentation/{{documentation/version}}/Developers/FAQ/Extensions|developer]] extension FAQs</p></li>
| |
| − | | |
| − | <li><p>(Optionally) Present your extension(s) on the [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel 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.</p></li>
| |
| − | | |
| − | <li><p>[[Documentation/{{documentation/version}}/Developers/Build_Instructions|Build Slicer application]] in <code>Release</code></p></li>
| |
| − | | |
| − | <li><p>Use the Wizard to create an extension bundling one Command line module:</p>
| |
| − | | |
| − | {{pre2|<nowiki>
| |
| − | $ cd Slicer-SuperBuild/Slicer-build
| |
| − | | |
| − | $ bin/slicerExtensionWizard --create Slicer-MyExtension --addModule cli:MyCLI ~
| |
| − | </nowiki>}}
| |
| − | | |
| − | <ol style="list-style-type:none; border-left:thick solid darkgreen; padding-left:1em;">
| |
| − | <li>By specifying <code>~</code> as destination, the extension will be created into your home directory.</li>
| |
| − | <li>Read our [[Documentation/{{documentation/version}}/Developers/FAQ/Extensions#Should_the_name_of_the_source_repository_match_the_name_of_the_extension_.3F|FAQ]] to learn about extension naming convention.
| |
| − | </ol>
| |
| − | | |
| − | To learn more about:
| |
| − | : the ExtensionWizard capabilities, click [[Documentation/{{documentation/version}}/Developers/ExtensionWizard|here]].
| |
| − | : the different type of modules, click [[Documentation/{{documentation/version}}/Developers/Modules|here]].
| |
| − | | |
| − | </li>
| |
| − | | |
| − | <li><p>If not already done, join [https://github.com/join Github] and [https://help.github.com/articles/set-up-git#set-up-git setup Git]</p></li>
| |
| − | | |
| − | <li><p>Save the source code of your extension by publishing it on Github</p>
| |
| − | | |
| − | {{pre2|<nowiki>$ bin/slicerExtensionWizard --publish ~/Slicer-MyExtension/</nowiki>}}
| |
| − | | |
| − | </li>
| |
| − | | |
| − | <li><p>Implement your extension. <code>Hack, hack, hack :)</code>. Make sure to commit often using meaningful commit message.</p></li>
| |
| − | | |
| − | <li><p>[[Documentation/{{documentation/version}}/Developers/Tutorials/DocumentExtension#Extension_page|Create a documentation page for your extension]].</p></li>
| |
| − | | |
| − | <li><p>[[Documentation/{{documentation/version}}/Developers/Tutorials/ObtainExtensionServerApiKey|Create an account on the extension server and obtain an API Key]]. You will then use your midas login and api key to substitute <code><YOUR-MIDAS-LOGIN></code> and <code><YOUR-MIDAS-APIKEY></code> in the examples.</p></li>
| |
| − | | |
| − | <li><p>If not already done, go to [http://slicer.kitware.com/midas3/community/23 NA-MIC community] and click on <code>Join community</code></p></li>
| |
| − | | |
| − | <li>Use of the experimental upload feature is optional: {{:Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions/ExperimentalFolderAccess}}</li>
| |
| − | | |
| − | <li><p>Assuming the source code of your extension is located in folder <code>MyExtension</code>, you could upload your extension doing:
| |
| − | | |
| − | <ol style="list-style-type:none; border-left:thick solid darkgreen; padding-left:1em;">
| |
| − | <li>To avoid typing the API email and key, you can set the environment variables <code>MIDAS_PACKAGE_EMAIL</code> and <code>MIDAS_PACKAGE_API_KEY</code>. More details [[Documentation/{{documentation/version}}/Developers/FAQ#How_to_cache_API_credentials_.3F|here]]</li>
| |
| − | </ol>
| |
| − | | |
| − | {|width = "100%"
| |
| − | ! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Linux or MacOSX (Makefile)
| |
| − | ! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Windows (Visual Studio)
| |
| − | |-
| |
| − | | valign="top" |
| |
| − | {{pre2|<nowiki>
| |
| − | $ 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
| |
| − | </nowiki>}}
| |
| − | | |
| − | '''MaxOSX''': Extension '''must be configured''' specifying <code>CMAKE_OSX_*</code> variables matching the one used to configure Slicer:
| |
| − | * <code>-DCMAKE_OSX_ARCHITECTURES:STRING=x86_64</code>
| |
| − | * <code>-DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=/same/as/Slicer</code>
| |
| − | * <code>-DCMAKE_OSX_SYSROOT:PATH=SameAsSlicer</code>
| |
| − | | |
| − | | valign="top" |
| |
| − | <ol start="1" style="list-style-type: decimal;">
| |
| − | <li>Start CMake, select source and build directory</li>
| |
| − | <li>Add <code>Slicer_DIR</code>, <code>MIDAS_PACKAGE_EMAIL</code> and <code>MIDAS_PACKAGE_API_KEY</code> entries to the cache</li>
| |
| − | [[File:Slicer Extensions Configure Windows.png|600px]]
| |
| − | <li>Click on <code>Configure</code>, select Generator, then click on <code>Generate</code> button.</li>
| |
| − | <li>Open <code>MyExtension.sln</code> (1), select <code>Release</code> configuration (2), select <code>ExperimentalUpload</code> (3) and <code>Build</code> (4).</li>
| |
| − | [[File:Slicer_Extension_ExperimentalUpload_Windows_VS2008.png|400px]]
| |
| − | </ol>
| |
| − | |}
| |
| − | </p></li>
| |
| − | | |
| − | <li><p>Check submission results on the dashboard: http://slicer.cdash.org/index.php?project=Slicer4#Extensions-Experimental</p>
| |
| − | <ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;">
| |
| − | <li>You should expect the test <code>MyCLITest</code> to fail with error of the form:
| |
| − | {{pre2|scroll|[nrrd] nrrdIoStateDataFileIterNext: couldn't open "~/MyExtension-build/MyCLI/Data/Baseline/CLIModuleTemplateTest.raw"}}
| |
| − | This is explained by the fact the <code>*.nhdr</code> file available on midas and downloaded locally still reference <code>CLIModuleTemplateTest.raw</code></li>
| |
| − | </ol>
| |
| − | </li>
| |
| − |
| |
| − | <li><p>Check that the extension can be installed by starting the Slicer executable from <code>/path/to/Slicer-Superbuild/Slicer-build</code> and installing your extension as explained [[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager|here]].</p></li>
| |
| − | | |
| − | <li><p>If you consider your extension is ready for distribution, contribute it to the ExtensionsIndex:</p>
| |
| − | | |
| − | {{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/</nowiki>}}
| |
| − | | |
| − | <ol style="list-style-type:none; border-left:thick solid darkgreen; padding-left:1em;">
| |
| − | <li>To contribute an extensions build against Slicer {{Documentation/currentversion}}. See [[Documentation/{{documentation/version}}/Developers/Tutorials/Contribute_Extension_Description_File_using_Extension_Wizard|here]].</li>
| |
| − | <li>To learn about extension description file format. See [[Documentation/{{documentation/version}}/Developers/Extensions/DescriptionFile|here]]</li>
| |
| − | </ol>
| |
| − | | |
| − | </li>
| |
| − | | |
| − | </ol>
| |
