Difference between revisions of "PET-CT/Development/Main"

From KitwarePublic
Jump to navigationJump to search
(Removing instructions on uploading to packages.kitware.com)
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=External Projects=
== Source code ==
The SlicerPET application is based on Slicer Framework. In addition to the external projects included by Slicer official, SlicerPET includes
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.
# PathPlanner
##GIT_REPOSITORY: "github.com/Will-S/PathPlanner.git"
##GIT_TAG: "2d2ed19b89d477a8540ac4dd76468e4911c3f7de"
# PlusLib
##SVN_REPOSITORY: "https://subversion.assembla.com/svn/plus/branches/Plus-1.8/PlusLib"
##SVN_REVISION: "-r "2670"
# VisualLine
##GIT_REPOSITORY "${git_protocol}://github.com/Will-S/VisuaLine.git"
##GIT_TAG "75b442fe6d81b230620e9c689766571dfc37e5c8"
#VolumeResliceDrive
##GIT_REPOSITORY "${git_protocol}://github.com/Will-S/VolumeResliceDriver.git"
##GIT_TAG "6f5b0e868f6f0a37404ee5cf09757de1ab7b43d4"


=Video Tools=
== Dashboard ==
To produce the videos showing how the different modules work, we used the following tools:
[http://kwcdash.kitware.com/CDash/index.php?project=SlicerPET SlicerPET dashboard]
 
==External Projects==
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.
 
== Building executable ==
* 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.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 [http://public.kitware.com/Wiki/PET-CT/Images#Videos], we used the following tools:
* On Windows:
* On Windows:
** We used [http://camstudio.org/ 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 [http://camstudio.org/ 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).
Line 21: Line 26:
* On Mac:
* On Mac:
** We used iMovie for post-production, editing and voice-over
** We used iMovie for post-production, editing and voice-over
=Upload packages=
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"

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