Repository files navigation

OpenVDB	AX	Nano	Houdini	License	CII

Website |Discussion Forum |Documentation |Releases |License |Slack

OpenVDB is an open source C++ library comprising a novel hierarchical datastructure and a large suite of tools for the efficient storage and manipulationof sparse volumetric data discretized on three-dimensional grids. It wasdeveloped by DreamWorks Animation for use in volumetric applications typicallyencountered in feature film production.

This GitHub repository hosts the trunk of the OpenVDB development. This impliesthat it is the newest public version with the latest features and bug fixes.However, it also means that it has not undergone a lot of testing and isgenerally less stable than theproduction releases.

OpenVDB is released under theApache License, Version 2.0,which is a free, open source software license developed and maintained by theApache Software Foundation.

The trademarks of any contributor to this project may not be used inassociation with the project without the contributor's express permission.

NOTE: OpenVDB has completed re-licensing fromMozilla Public License Version 2.0 toApache License, Version 2.0. Please see the file RE-LICENSE_NOTE.txt for more details.

OpenVDB welcomes contributions to the OpenVDB project. Please refer to thecontribution guidelines for details on how to make acontribution.

The following provides basic installation examples for the core OpenVDB library.Other components, such as the python module, OpenVDB AX, NanoVDB and variousexecutables, may require additional dependencies. See thebuild documentationfor help with installations.

# Linux# @note If your distribution does not have required versions, consider using#   apt pinning. See the dependency documentation for more details.apt-get install -y libboost-iostreams-devapt-get install -y libtbb-devapt-get install -y libblosc-dev# MacOS# @note We are using homebrew in this example to install requried dependencies#  https://brew.sh/brew install boostbrew install tbbbrew install c-blosc

git clone git@github.com:AcademySoftwareFoundation/openvdb.gitcd openvdbmkdir buildcd buildcmake ..make -j4&& make install

Note that the following commands have only been tested for 64bit systems/libraries.It is recommended to set theVCPKG_DEFAULT_TRIPLET environment variable tox64-windows to use 64-bit libraries by default. You will also requireVisual Studio (for the MSVC C++runtime and compiler toolchains),CMake and optionallyvcpkg for the installation of OpenVDB'sdependencies.

vcpkg install zlib:x64-windowsvcpkg install blosc:x64-windowsvcpkg install tbb:x64-windowsvcpkg install boost-iostreams:x64-windowsvcpkg install boost-any:x64-windowsvcpkg install boost-algorithm:x64-windowsvcpkg install boost-interprocess:x64-windows

git clone git@github.com:AcademySoftwareFoundation/openvdb.gitcd openvdbmkdir buildcd buildcmake -DCMAKE_TOOLCHAIN_FILE=<PATH_TO_VCPKG>\scripts\buildsystems\vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows -A x64 ..cmake --build. --parallel 4 --config Release --target install

OpenVDB AX depends on the core OpenVDB library. NanoVDB can be built with andwithout OpenVDB support. Note that NanoVDB has its own build instructions, seetheNanoVDB build documentationfor details.

The following variables can be passed to thecmake configure command. Thereare more optional VDB components, see thebuild documentationfor a complete list.