PET-CT/Development/Main: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
(Removing instructions on uploading to packages.kitware.com)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Source code ==
Source code in Kitware's public [https://gitlab.kitware.com/petct/SlicerPET GitLab]. The project uses [https://cmake.org/ CMake], a cross-platform build configuration system. Particularly, SlicerPET uses superbuild feature of CMake.
== Dashboard ==
== Dashboard ==
[https://www.kitware.com/CDash/index.php?project=SlicerPET SlicerPET dashboard]
[http://kwcdash.kitware.com/CDash/index.php?project=SlicerPET SlicerPET dashboard]


==External Projects==
==External Projects==
The SlicerPET application is based on Slicer Framework. In addition to the external projects included by Slicer official, SlicerPET includes  
The SlicerPET application is based on Slicer Framework. In addition to the external projects included by Slicer official, SlicerPET includes [https://subversion.assembla.com/svn/plus/trunk/PlusLib PlusLib] revision 3900.
# PlusLib
##SVN_REPOSITORY: "https://subversion.assembla.com/svn/plus/branches/Plus-1.8/PlusLib"
##SVN_REVISION: "-r "2670"
# PathPlanner
##GIT_REPOSITORY: "[https://github.com/andinet/PathPlanner https://github.com/andinet/PathPlanner]"
##GIT_TAG: "2d2ed19b89d477a8540ac4dd76468e4911c3f7de"
# VisualLine
##GIT_REPOSITORY "[https://github.com/andinet/VisuaLine https://github.com/andinet/VisuaLine]"
##GIT_TAG "75b442fe6d81b230620e9c689766571dfc37e5c8"
#VolumeResliceDrive
##GIT_REPOSITORY "[https://github.com/andinet/VolumeResliceDriver https://github.com/andinet/VolumeResliceDriver]"
##GIT_TAG "6f5b0e868f6f0a37404ee5cf09757de1ab7b43d4"


== Building executable ==  
== Building executable ==  
* [http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Developers/Build_Instructions Follow 3D Slicer 4.3 build instructions]
* Standard CMake configure/build workflow should be followed. If you are not familiar with it, see [https://cmake.org/runningcmake/ running CMake] or [http://www.slicer.org/slicerWiki/index.php/Documentation/4.5/Developers/Build_Instructions 3D Slicer 4.5 build instructions]
* The executable is SlicerPET which can be found in SlicerPET64R/Slicer-build/Slicer-build  ( Windows )
* The executable is SlicerPET.exe which can be found in BuildDir/S-bld/Slicer-build  ( Windows )
** If you would like to start the application from the build tree, in SlicerPETLauncherSetting.ini, add the following line at the end of [LibraryPaths] section:
  path=C:/bin/SlicerPET64R/Slicer-build/PlusLib-build/bin/Release
  size=21


== Generating installers ==
== Generating installers ==
Line 28: Line 16:
* Install NSIS in your system
* Install NSIS in your system
* Build SlicerPET in a release mode
* Build SlicerPET in a release mode
* When the build finishes, generate Slicer-build project file in visual studio
* When the build finishes, load S-bld/Slicer-build/Slicer.sln project file in Visual Studio
* Run PACKAGE project target to generate the installer
* Build PACKAGE target only to generate the installer. There will be a new installer in S-bld/Slicer-build/ with a filename SlicerPET-2.0.0-*-win-amd64.exe
 
==Uploading installers to Packages server  ==
How to upload packages to [http://packages.kitware.com/packages/application/view?applicationId=15 packages.kitware.com]:
* Create an account and join the PET-CT community
* Download the following script : [http://public.kitware.com/Wiki/File:Upload-SlicerPET-to-packages-kitware-com.cmake Upload-SlicerPET-to-packages-kitware-com.cmake]
** Change the MIDAS_USER and enter you MIDAS_API_KEY that you can generate in your packages.kitware.com profile.
** Modify the following lines if you are uploading windows or linux executables to the appropriate values:
  file(GLOB packages "SlicerPET-*.exe")
  ...
  PACKAGE_TYPE "NSIS installer"
* Run the command line "cmake -P Upload-SlicerPET-to-packages-kitware-com.cmake"


==Video Tools==
==Video Tools==

Latest revision as of 17:01, 16 December 2015

Source code

Source code in Kitware's public GitLab. The project uses CMake, a cross-platform build configuration system. Particularly, SlicerPET uses superbuild feature of CMake.

Dashboard

SlicerPET dashboard

External Projects

The SlicerPET application is based on Slicer Framework. In addition to the external projects included by Slicer official, SlicerPET includes PlusLib revision 3900.

Building executable

  • Standard CMake configure/build workflow should be followed. If you are not familiar with it, see running CMake or 3D Slicer 4.5 build instructions
  • The executable is SlicerPET.exe which can be found in BuildDir/S-bld/Slicer-build ( Windows )

Generating installers

Windows

  • Install NSIS in your system
  • Build SlicerPET in a release mode
  • When the build finishes, load S-bld/Slicer-build/Slicer.sln project file in Visual Studio
  • Build PACKAGE target only to generate the installer. There will be a new installer in S-bld/Slicer-build/ with a filename SlicerPET-2.0.0-*-win-amd64.exe

Video Tools

To produce the videos showing how the different modules work [1], we used the following tools:

  • On Windows:
    • We used CamStudio, a tool that allows to record all screen and audio activity on the computer. To improve the quality of the videos, we boosted the video option of the tool to the maximum (Quality 100% and 1000 frame per second).
    • We used VLC to record the streaming video from a camera device.
  • On Mac:
    • We used iMovie for post-production, editing and voice-over