OpenVDB  6.1.0
Dependencies

Contents


Note: The dependency information on this page details a complete requirements list for building OpenVDB as a standalone package. If you wish to use OpenVDB with a supported 3rd party DCC (Houdini/Maya), make sure you've first read the Building OpenVDB information.


There are a number of optional and required dependencies necessary when building different components of OpenVDB. Below you'll find a full list of all dependencies, any minimum/recommended version requirements and some guides for getting these dependencies installed. You'll also find information on any known issues with particular software. Please report any issues not listed here to the OpenVDB TSC.

Note that OpenVDB is production tested against the VFX Reference Platform. Not all dependencies exist in the VFX Reference Platform, but for those that do, their specified versions are always recommended.

OpenVDB Components

Component Requirements Optional
OpenVDB Core Library CMake, C++11 compiler, IlmBase::Half, TBB::tbb, ZLIB, Boost::system, Boost::iostream Blosc, Log4cplus, OpenEXR::IlmImf
OpenVDB Print Core Library dependencies -
OpenVDB LOD Core Library dependencies -
OpenVDB Render Core Library dependencies, OpenEXR, IlmBase -
OpenVDB View Core Library dependencies, OpenGL, GLFW3, Boost::thread -
OpenVDB Python Core Library dependencies, Python, Boost::python NumPy
OpenVDB UnitTests Core Library dependencies, CppUnit -
OpenVDB Documentation Doxygen -

Dependency Table

Package Minimum Recommended Description apt-get Homebrew Source
CMake 3.3 Latest Cross-platform family of tools designed to help build software Y Y https://cmake.org
GCC 4.8 6.3.1 C++ 11 Compiler: The GNU Compiler Collection Y Y https://www.gnu.org/software/gcc
Clang 3.8 Latest C++ 11 Compiler: A C language family frontend for LLVM Y Y https://clang.llvm.org
Intel ICC 15 Latest C++ 11 Compiler: Intels C++ Compiler Y Y https://software.intel.com/en-us/c-compilers
IlmBase 2.2 2.2 Used half precision floating points and EXR serialization support Y Y http://www.openexr.com
OpenEXR 2.2 2.2 EXR serialization support Y Y http://www.openexr.com
TBB 4.4 2017 U6 Threading Building Blocks - template library for task parallelism Y Y https://www.threadingbuildingblocks.org
ZLIB 1.2.7 Latest Compression library for disk serialization compression Y Y https://www.zlib.net
Boost 1.61 1.61 Components: system, iostreams, python, thread Y Y https://www.boost.org
Python 2.7 2.7 The python interpreter and libraries for C++/python bindings Y Y https://www.python.org
NumPy 1.9.2 1.9.2 Scientific computing with Python Y Y http://www.numpy.org
CppUnit 1.10 Latest A unit testing framework module for C++ N Y https://freedesktop.org/wiki/Software/cppunit
Blosc 1.5* 1.5* Recommended dependency for improved disk compression N N** https://github.com/Blosc/c-blosc/releases
Log4cplus 1.1.2 Latest An optional dependency for improved OpenVDB Logging Y Y https://github.com/log4cplus/log4cplus
GLFW 3.0 Latest Simple API for OpenGL development Y Y https://www.glfw.org
OpenGL 3.2 Latest Environment for developing portable graphics applications Y Y https://www.opengl.org
Doxygen 1.8.8 1.8.11 Documentation generation from C++ Y Y http://www.doxygen.nl

Known Issues

GLFW: Crash with GLFW 3.2.1 when used with EGL on Linux. OpenVDB View may segfault on closure. Whilst this has been fixed in the GLFW repository, there is no new release.

Installing Dependencies

This section details a number of ways to get you up and running with the required OpenVDB dependencies.

Using UNIX apt-get

Note: Blosc and CppUnit are unavailable using apt-get. See the other package manager methods or the manual installation options.

1 #!/bin/bash
2 apt-get install cmake # CMake
3 apt-get install libilmbase-dev # IlmBase
4 apt-get install libopenexr-dev # OpenEXR
5 apt-get install libtbb-dev # TBB
6 apt-get install zlibc # zlib
7 apt-get install libboost-system-dev # Boost::system
8 apt-get install libboost-iostreams-dev # Boost::iostream
9 apt-get install libboost-python-dev # Boost::python
10 apt-get install libboost-thread-dev # Boost::thread
11 apt-get install python-dev # Python
12 apt-get install python-numpy # NumPy
13 apt-get install liblog4cplus-dev # Log4cplus
14 apt-get install libglfw3-dev # GLFW
15 apt-get install doxygen # doxygen

Using Homebrew

Homebrew is a package manager for UNIX systems and is an alternative to apt-get or manual installation from source.

Note: Homebrew installs blosc 1.16 by default with no option for previous versions. OpenVDB recommends Blosc version 1.5 as there are known issues with using later versions of blosc. See the manual installation options.

1 #!/bin/bash
2 brew install cmake # CMake
3 brew install ilmbase # IlmBase
4 brew install openexr # OpenEXR
5 brew install tbb # TBB
6 brew install zlib # zlib
7 brew install boost # Boost
8 brew install boost-python # Boost-python
9 brew install python # Python
10 brew install numpy # NumPy
11 brew install cppunit # CppUnit
12 brew install glfw # GLFW
13 brew install doxygen # Doxygen

UNIX Manual Installations

Some dependencies may be unavailable using the above package manager methods. Below are manual installation methods for these packages. Note that you will have to provide your chosen installation locations to the OpenVDB CMake build system when building OpenVDB.

Blosc

1 #!/bin/bash
2 wget https://github.com/Blosc/c-blosc/archive/v1.5.0.zip
3 unzip v1.5.0.zip
4 cd c-blosc-1.5.0
5 # Install to users home directory - you may customise this location
6 mkdir -p $HOME/blosc
7 # Requires CMake
8 cmake -DCMAKE_INSTALL_PREFIX=$HOME/blosc
9 make
10 make install

CppUnit

1 #!/bin/bash
2 wget http://dev-www.libreoffice.org/src/cppunit-1.13.2.tar.gz
3 tar -xvzf cppunit-1.13.2.tar.gz
4 cd cppunit-1.13.2
5 # Install to users home directory - you may customise this location
6 mkdir -p $HOME/cppunit
7 ./configure --prefix=$HOME/cppunit
8 make
9 make install