Difference between revisions of "2012 Summer Project Week Breakout Session:SlicerExtensions"

From NAMIC Wiki
Jump to: navigation, search
m
m
Line 5: Line 5:
  
 
* Tour of the [http://wiki.slicer.org/slicerWiki/index.php?title=Documentation/4.1 updated documentation]
 
* Tour of the [http://wiki.slicer.org/slicerWiki/index.php?title=Documentation/4.1 updated documentation]
−
* Demo: Extension bundling one CLI module
+
* Step-by-step: Extension bundling one CLI module
 
* Q&A
 
* Q&A
  
Line 11: Line 11:
  
  
−
= Demo: Extension bundling one CLI module =
+
 
 +
= Step-by-step: Extension bundling one CLI module =
 +
 
 +
== Prerequisites ==
 +
 
 +
* Up-to-date Slicer build - This step by step tutorial has been done using Slicer r20398
 +
 
 +
== Step-by-step==
 +
 
 +
* 1. Create base structure using ModuleWizard
 +
<pre>
 +
./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate --target ../MyFooExtension MyFooExtension
 +
</pre>
 +
 
 +
* 2. Check that file have been created
 +
<pre>
 +
cd ..
 +
cd MyFooExtension/
 +
ls
 +
cd ..
 +
cd MyFooExtension-build
 +
</pre>
 +
 
 +
* 3. Configure
 +
<pre>
 +
cmake -DSlicer_DIR:PATH=/home/jchris/Projects/Slicer4-Superbuild-Debug/Slicer-build/ ../MyFooExtension
 +
</pre>
 +
 
 +
* 4. Build
 +
<pre>
 +
make -j4
 +
</pre>
 +
 
 +
* 5. Read "How to obtain an API key"
 +
 
 +
* 6. Re-configure passing <code>MIDAS_PACKAGE_EMAIL</code> and <code>MIDAS_PACKAGE_API_KEY</code>
 +
 
 +
<pre>
 +
cd MyFooExtension-build
 +
cmake -DMIDAS_PACKAGE_EMAIL:STRING=jchris.fillionr@kitware.com -DMIDAS_PACKAGE_API_KEY:STRING=<YOUR_API_KEY> .
 +
</pre>
 +
 
 +
* 7. Publish
 +
 
 +
<pre>
 +
make ExperimentalUpload
 +
</pre>

Revision as of 18:12, 18 June 2012

Home < 2012 Summer Project Week Breakout Session:SlicerExtensions

Back to agenda

An extension could be seen as a delivery package bundling together one or more Slicer modules. After installing an extension, the associated modules will be presented to the user as built-in ones




Step-by-step: Extension bundling one CLI module

Prerequisites

  • Up-to-date Slicer build - This step by step tutorial has been done using Slicer r20398

Step-by-step

  • 1. Create base structure using ModuleWizard
./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate --target ../MyFooExtension MyFooExtension
  • 2. Check that file have been created
cd ..
cd MyFooExtension/
ls
cd ..
cd MyFooExtension-build
  • 3. Configure
cmake -DSlicer_DIR:PATH=/home/jchris/Projects/Slicer4-Superbuild-Debug/Slicer-build/ ../MyFooExtension
  • 4. Build
make -j4
  • 5. Read "How to obtain an API key"
  • 6. Re-configure passing MIDAS_PACKAGE_EMAIL and MIDAS_PACKAGE_API_KEY
cd MyFooExtension-build
cmake -DMIDAS_PACKAGE_EMAIL:STRING=jchris.fillionr@kitware.com -DMIDAS_PACKAGE_API_KEY:STRING=<YOUR_API_KEY> .
  • 7. Publish
make ExperimentalUpload
Retrieved from "https://www.na-mic.org/w/index.php?title=2012_Summer_Project_Week_Breakout_Session:SlicerExtensions&oldid=76405"