Installation instructions

Installing ClearVolume

Overall Prerequisites:

1. Java JDK or JRE version 7 or 8 (1.7 or 1.8)
2. Gradle 2.1 (get it here)
3. Prerequisites for either the CUDA or OpenCL backend

Prerequisites for CUDA backend:

1. NVidia graphics card
2. CUDA SDK 6.5 (get it here)
3. On windows you need VisualStudio installed (get it here) If you use an 'express' version of VisualStudio, you need to copy and rename the file 'vcvarsx86_amd64.bat' located in folder 'Microsoft Visual Studio 12.0\VC\bin\x86_amd64' to 'vcvars64.bat' that should be placed at the root of the VisualStudio folder e.g. 'C:\Program Files (x86)\Microsoft Visual Studio 12.0'. run gradle test an check for messages that suggest that that file could not be found.

Prerequisites for OpenCL backend:

1. OpenCL 1.2 capable graphics card with preferably at least 1G of GPU RAM.

####Prerequisites for LabVIEW bindings:

1. LabVIEW 2012 64 bit.

Note: LabVIEW users can regenerate the LabVIEW bindings from almost any LabVIEW 64bit version using the LabVIEW wizard for interfacing with native C/C++ libraries. Unfortunately 32 bit is out of the questions in the 21st century - and makes little sense when handling volume data anyway...

How to get the latest code

Checkout the project using Git

git clone https://github.com/ClearVolume/ClearVolume.git

or go to the download page and download the whole repository.

This download will only provide you with the source code. To obtain usable binaries, you need to follow the instructions below or have a look at the other downloads provided (for C/C++ and LabVIEW users).

How to build project with Gradle

• Get Gradle here

• Go to the project folder root and run:

  ./build.sh

This will generate a jar executable here:

./build/executable/ClearVolume.exe.jar

(It uses the magic Capsule plugin for Gradle for that)

Quick demo:

Linux/ OSX:

Start the demo server (Linux or OSX):

./build/executable/ClearVolume.exe.jar --demo-server > log.txt &

Start the network client (Linux or OSX):

./build/executable/ClearVolume.exe.jar

Windows:

java -jar ClearVolume.exe.jar

You can also simply double click on the ClearVolume.exe.jar file (OSX, Linux)

Connect to the server on localhost. Et Voila! You should see a volume rendering of a 3D Volume stream (changing 3D data).