Difference between revisions of "Documentation/4.0/Developers/DirectoryStructure"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
Back to [[Documentation/{{documentation/version}}/Developers/Build_system|Build System]]&larr;
  
= Slicer install and build tree =
+
= Slicer =
 +
 
 +
== Build tree ==
 +
 
 +
<pre>
 +
Slicer_HOME
 +
|
 +
+ bin
 +
|  |
 +
|  + designer
 +
|  |
 +
|  + iconengines
 +
|
 +
+ lib
 +
|  |
 +
|  + Slicer-X.Y
 +
|      |
 +
|      + cli-modules
 +
|      |
 +
|      + qt-loadable-modules
 +
|      |
 +
|      + qt-scripted-modules
 +
|
 +
+ share
 +
  |
 +
  + Slicer-X.Y
 +
      |
 +
      + cli-modules
 +
      |  |
 +
      |  + CLIModuleName1
 +
      |  |
 +
      .  .
 +
      |  |
 +
      |  + CLIModuleNameN
 +
      |
 +
      + qt-loadable-modules
 +
      |  |
 +
      |  + QtLoadableModuleName1
 +
      |  |
 +
      .  .
 +
      |  |
 +
      |  + QtLoadableModuleNameN
 +
      |
 +
      + qt-scripted-modules
 +
      |  |
 +
      |  + QtScriptedModuleName1
 +
      |  |
 +
      .  .
 +
      |  |
 +
      |  + QtScriptedModuleNameN
 +
      |
 +
      + Tcl
 +
      |
 +
      + ParameterSets
 +
      |
 +
      + ColorFiles
 +
   
 +
 +
</pre>
 +
 
 +
== Install tree ==
  
 
<pre>
 
<pre>
 
Slicer_HOME
 
Slicer_HOME
 
  |
 
  |
  + bin  
+
  + bin
 
  |
 
  |
 
  + lib
 
  + lib
 +
|  |
 +
|  + QtPlugins
 +
|  |  |
 +
|  |  + designer
 +
|  |  |
 +
|  |  + imageformats
 +
|  |  |
 +
|  |  + iconengines
 +
|  |  |
 +
|  |  + sqldrivers
 
  |  |
 
  |  |
 
  |  + Slicer-X.Y
 
  |  + Slicer-X.Y
Line 54: Line 126:
 
</pre>
 
</pre>
  
{{note}} The X and Y in ''Slicer-X.Y'' stands for ''Slicer_MAJOR_VERSION'' and ''Slicer_MINOR_VERSION''
+
{{note}} The X and Y in ''Slicer-X.Y'' respectively stand for ''Slicer_MAJOR_VERSION'' and ''Slicer_MINOR_VERSION''
  
 
= Extension install and build tree =
 
= Extension install and build tree =
Line 100: Line 172:
 
        
 
        
 
</pre>
 
</pre>
 +
 +
= API =
 +
 +
* '''[http://slicer.org/doc/html/classvtkSlicerApplicationLogic.html vtkSlicerApplicationLogic]''' provides some convenient functions allowing to obtain the share directory associated with a given module filepath.
 +
 +
* Note also that if ''vtkSlicerConfigure'' is included the macros ''Slicer_CLIMODULES_SUBDIR'', ''Slicer_QTLOADABLEMODULES_SUBDIR'' and ''Slicer_QTSCRIPTEDMODULES_SUBDIR'' will be available.
 +
 +
* Application settings (including the search path for modules/extensions) are stored in a ''.ini'' file. The location of the file depends on the OS:
 +
** Linux + Mac OS X: ''~/.config/www.na-mic.org/Slicer.ini''
 +
** Windows: ''C:\Users\USERNAME\AppData\Roaming\NA-MIC\Slicer.ini''

Latest revision as of 07:28, 14 June 2013

Home < Documentation < 4.0 < Developers < DirectoryStructure

For the latest Slicer developers documentation, visit the Nightly page.

Back to Build System

Slicer

Build tree

Slicer_HOME
 |
 + bin
 |  |
 |  + designer
 |  |
 |  + iconengines
 |
 + lib
 |  |
 |  + Slicer-X.Y
 |      |
 |      + cli-modules
 |      |
 |      + qt-loadable-modules
 |      |
 |      + qt-scripted-modules
 |
 + share
   |
   + Slicer-X.Y
      |
      + cli-modules
      |   |
      |   + CLIModuleName1
      |   |
      .   .
      |   |
      |   + CLIModuleNameN
      |
      + qt-loadable-modules
      |   |
      |   + QtLoadableModuleName1
      |   |
      .   .
      |   |
      |   + QtLoadableModuleNameN
      |
      + qt-scripted-modules
      |   |
      |   + QtScriptedModuleName1
      |   |
      .   .
      |   |
      |   + QtScriptedModuleNameN
      |
      + Tcl
      |
      + ParameterSets
      |
      + ColorFiles
    
 

Install tree

Slicer_HOME
 |
 + bin
 |
 + lib
 |  |
 |  + QtPlugins 
 |  |   |
 |  |   + designer
 |  |   |
 |  |   + imageformats
 |  |   |
 |  |   + iconengines
 |  |   |
 |  |   + sqldrivers
 |  |
 |  + Slicer-X.Y
 |      |
 |      + cli-modules
 |      |
 |      + qt-loadable-modules
 |      |
 |      + qt-scripted-modules
 |
 + share
   |
   + Slicer-X.Y
      |
      + cli-modules
      |   |
      |   + CLIModuleName1
      |   |
      .   .
      |   |
      |   + CLIModuleNameN
      |
      + qt-loadable-modules
      |   |
      |   + QtLoadableModuleName1
      |   |
      .   .
      |   |
      |   + QtLoadableModuleNameN
      |
      + qt-scripted-modules
      |   |
      |   + QtScriptedModuleName1
      |   |
      .   .
      |   |
      |   + QtScriptedModuleNameN
      |
      + Tcl
      |
      + ParameterSets
      |
      + ColorFiles
    
 

Note The X and Y in Slicer-X.Y respectively stand for Slicer_MAJOR_VERSION and Slicer_MINOR_VERSION

Extension install and build tree

INSTALL_LOCATION
 |
 + lib
 |  |
 |  + Slicer-X.Y
 |      |
 |      + cli-modules
 |      |
 |      + qt-loadable-modules
 |      |
 |      + qt-scripted-modules
 |
 + share
   |
   + Slicer-X.Y
      |
      + cli-modules
      |   |
      |   + CLIModuleName1
      |   |
      .   .
      |   |
      |   + CLIModuleNameN
      |
      + qt-loadable-modules
      |   |
      |   + QtLoadableModuleName1
      |   |
      .   .
      |   |
      |   + QtLoadableModuleNameN
      |
      + qt-scripted-modules
         |
         + QtScriptedModuleName1
         |
         .
         |
         + QtScriptedModuleNameN
      

API

  • vtkSlicerApplicationLogic provides some convenient functions allowing to obtain the share directory associated with a given module filepath.
  • Note also that if vtkSlicerConfigure is included the macros Slicer_CLIMODULES_SUBDIR, Slicer_QTLOADABLEMODULES_SUBDIR and Slicer_QTSCRIPTEDMODULES_SUBDIR will be available.
  • Application settings (including the search path for modules/extensions) are stored in a .ini file. The location of the file depends on the OS:
    • Linux + Mac OS X: ~/.config/www.na-mic.org/Slicer.ini
    • Windows: C:\Users\USERNAME\AppData\Roaming\NA-MIC\Slicer.ini