Skip to content

Latest commit

 

History

History
112 lines (75 loc) · 4.45 KB

INSTALL.md

File metadata and controls

112 lines (75 loc) · 4.45 KB
Raw

Installing VDBFusion

Most of the people can do pip install vdbfusion and get the Python bindings for this project. If you wish to build the project from source because you are doing modifications you have few options available.

Build from source in a Conda environment

Tested on MacOS and Linux.

You need a Conda variant installed. The following instructions use MambaForge (it is significantly faster).

Create a new environment and activate it.

conda create -n vdbfusion python=3.9
conda activate vdbfusion

Install dependencies.

mamba install cmake llvm ccache ninja pkg-config blosc boost eigen tbb tbb-devel pytest numpy black pybind11 twine

Clone the repository and enter it.

git clone https://github.com/PRBonn/vdbfusion.git && cd vdbfusion

Build OpenVDB from source.

git clone --depth 1 https://github.com/nachovizzo/openvdb.git -b nacho/vdbfusion \
    && cd openvdb \
    && mkdir build && cd build \
    && cmake \
    -DOPENVDB_BUILD_PYTHON_MODULE=ON \
    -DUSE_NUMPY=ON \
    -DPYOPENVDB_INSTALL_DIRECTORY="/usr/local/lib/python3.9/dist-packages" \
    -DCMAKE_POSITION_INDEPENDENT_CODE=ON \
    -DUSE_ZLIB=OFF \
    ..\
    && make -j$(nproc) all install \
    && cd ../.. \
    && rm -rf /openvdb

From the root of the repository, build the C++ API and install it into user space.

mkdir -p build && cd build && cmake ..
make install

Launching your IDE from the terminal in your active environment will allow it to pick up your environment variables.

If cmake is unable to find TBB, set your TBB_ROOT to the root of your conda environment as a build flag in your IDE.

-DTBB_ROOT=/path/to/conda/envs/vdbfusion

Build from source in Linux

I spent some extra time trying to make the build work on different Linux distributions like Ubuntu, Debian, CentOs, etc. The build (or superbuild) includes all the necessary tools to pull 3rdparty dependencies. If you are developing something on top of VDBFusion I would recommend to check Using system installed 3rdparty libraries instead. More information about building can be found on the CI/CD configuration

Minimal setup

To build the project from source you only need:

  • A C++ compiler
  • git
  • Python3

If you are using Ubuntu this command should be enough to get you started:

sudo apt-get update && sudo apt-get install build-essential cmake git python3 python3-dev python3-pip

After that you can run make install (at the root of this project) to install the python bindings on your system. If you wish to also install the C++ bindings, this is not yet supported on the superbuild. You will first need to install all the 3rdparty dependencies yourself. Check Using system installed 3rdparty libraries and then Installing the C++ API.

Using system installed 3rdparty libraries

Assuming you have installed all 3rdparty dependencies (OpenVDB, Eigen3, pybind11). Then you can build the project the same way as before without any extra effort. You can see this Dockerfile to understand how I do it on the CI/CD.

Installing the C++ API

This is still under development and only supported for dev builds (all 3rdparty dependencies installed locally).

mkdir -p build && cd build && cmake ..
sudo make install

This will install the C++ API on your system that can be found on any other CMake consumer project using the find_package command:

find_package(VDBFusion REQUIRED)
add_executable(my_example my_example.cpp)
target_link_libraries(my_examples PRIVATE VDBFusion::vdbfusion)

If you want to know more about this you can also check the C++ example

Build Configuration

Most of the variables you can control are on the root CMakeLists.txt. Make sure you check them out if something on your build is not properly working.

Build from source in Windows/macOS

I don't use Windows or macOS, so initially I'm not providing support for these systems. Although it should be straightforward to build the project there since the only real dependencies are a C++ compiler and a Python3 interpreter. You can check the minimal docker setup needed to build VDBFusion and port it to your system.