BUILD.md

Build and Package vpaw

This document summarizes how to build and package vpaw on Windows. Instructions for Linux and macOS are similar. For more details, see 3D Slicer Developer Wiki

vpaw is a custom Slicer application. Reading the 3D Slicer Developer Documentation may help answer additional questions.

The initial source files were created using KitwareMedical/SlicerCustomAppTemplate.

Prerequisites

• Microsoft Windows 10 or above recommended

• Supported Microsoft Visual Studio versions:

  • Visual Studio 17 2022

• CMake, version 3.16.3 or above

• Qt, version 5.15.2 recommended

• Git

• Setting up your git account:

  • Create a Github account.

  • Setup your SSH keys following these instructions, with the exception of step 2 where you should NOT enter a passphrase.

  • Setup your git username and your git email.

  • If not already done, email FirstName LastName <[email protected]> to be granted access to the KitwareMedical/vpaw repository.

Checkout

1. Start Git Bash
2. Checkout the source code into a directory C:\W\ by typing the following commands:

cd /c
mkdir W
cd /c/W
git clone https://github.com/KitwareMedical/vpaw.git v

Note: use short source and build directory names to avoid the maximum path length limitation.

Build

Note: The build process will take approximately 3 hours on a modern computer.

Option 1: CMake GUI and Visual Studio (Recommended)

1. Start CMake GUI, select source directory C:\W\v and set build directory to C:\W\vR.
2. Add an entry Qt5_DIR pointing to C:/Qt/${QT_VERSION}/${COMPILER}/lib/cmake/Qt5.
3. Generate the project.
4. Open C:\W\vR\vpaw.sln, select Release and build the project.

Option 2: Command Line

1. Start the Command Line Prompt
2. Configure and build the project in C:\W\vR by typing the following commands:

cd C:\W\
mkdir vR
cd vR
cmake -G "Visual Studio 17 2022" -A x64 -DQt5_DIR:PATH=`C:/Qt/${QT_VERSION}/${COMPILER}/lib/cmake/Qt5 ..\v
cmake --build . --config Release -- /maxcpucount:4

Package

Install NSIS 2

Option 1: CMake and Visual Studio (Recommended)

1. In the C:\W\vR\Slicer-build directory, open Slicer.sln and build the PACKAGE target

Option 2: Command Line

1. Start the Command Line Prompt
2. Build the package target by typing the following commands:

cd C:\W\vR\Slicer-build
cmake --build . --config Release --target package