Updated build documentation fix some pybind compiler warnings/CI

Signed-off-by: Nick Avramoussis <4256455+Idclip@users.noreply.github.com>

Author: Idclip

.github/workflows/weekly.yml

@@ -289,7 +289,7 @@ jobs:
       run: |
         vcpkg update
         vcpkg install zlib tbb cppunit blosc python3 \
-          boost-iostreams boost-system boost-any boost-uuid boost-interprocess boost-algorithm boost-python
+          boost-iostreams boost-system boost-any boost-uuid boost-interprocess boost-algorithm pybind11
     - name: build
       shell: bash
       run: >

README.md

@@ -39,6 +39,8 @@ The following provides basic installation examples for the core OpenVDB library.
 ##### Installing Dependencies (Boost, TBB, Blosc)
 
 ```bash
+# @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-dev
 apt-get install -y libtbb-dev
 apt-get install -y libblosc-dev

cmake/config/OpenVDBVersions.cmake

@@ -40,6 +40,7 @@ if(NOT DISABLE_DEPENDENCY_VERSION_CHECKS)
   set(MINIMUM_MSVC_VERSION 19.10) # 1910 (Visual Studio 2017 15.0)
 
   set(MINIMUM_BOOST_VERSION 1.73)
+  set(MINIMUM_PYBIND_VERSION 2.9.1)
   set(MINIMUM_ILMBASE_VERSION 2.4)
   set(MINIMUM_OPENEXR_VERSION 2.4)
   set(MINIMUM_ZLIB_VERSION 1.2.7)

doc/build.txt

@@ -257,12 +257,13 @@ Package        | Description
 -------------- | --------------------------------------------------------------- | ------------------ |
 CMake          | Cross-platform family of tools designed to help build software  | All                |
 C++17 Compiler | Matching Houdini compiler and version                           | All                |
-Boost          | Components: iostreams, python, thread                           | All                |
+Boost          | Components: iostreams                                           | All                |
 GoogleTest     | A unit testing framework module for C++                         | Unit Tests         |
 CppUnit        | A unit testing framework module for C++                         | Unit Tests (AX)    |
 GLFW           | Simple API for OpenGL development                               | OpenVDB View       |
 Doxygen        | Documentation generation from C++                               | Documentation      |
 Log4cplus      | An optional dependency for improved OpenVDB Logging             | Optional (All)     |
+PyBind11       | C++/python bindings                                             | Optional (Python)  |
 NumPy          | Scientific computing with Python                                | Optional (Python)  |
 LLVM           | Target-independent code generation                              | OpenVDB AX         |
 
@@ -346,7 +347,7 @@ Package        | Description
 -------------- | ---------------------------------------------------------------   | -------------------------------- |
 CMake          | Cross-platform family of tools designed to help build software    | All                              |
 C++17 Compiler | Matching Houdini compiler and version                             | All                              |
-Boost          | Components: iostreams, python, thread                             | All                              |
+Boost          | Components: iostreams                                             | All                              |
 ZLIB           | Compression library for disk serialization compression            | All                              |
 Blosc          | Recommended dependency for improved disk compression              | All*                             |
 GoogleTest     | A unit testing framework module for C++                           | Unit Tests                       |
@@ -356,6 +357,7 @@ Doxygen        | Documentation generation from C++
 OpenEXR        | EXR serialization support                                         | OpenVDB Render                   |
 IlmBase        | Used half precision floating points and EXR serialization support | Optional (All)                   |
 Log4cplus      | An optional dependency for improved OpenVDB Logging               | Optional (All)                   |
+PyBind11       | C++/python bindings                                               | Optional (Python)                |
 NumPy          | Scientific computing with Python                                  | Optional (Python)                |
 LLVM           | Target-independent code generation                                | OpenVDB AX                       |
 

doc/dependencies.txt

@@ -35,18 +35,18 @@ Reference Platform, but for those that do, their specified versions are
 
 @section depComponents OpenVDB Components
 
-Component               | Requirements                                      | Optional
------------------------ | ------------------------------------------------- | --------
-OpenVDB Core Library    | CMake, C++17 compiler, TBB::tbb, Boost::headers   | Blosc, ZLib, Log4cplus, IlmBase::Half, Boost::iostream
-OpenVDB Print           | Core Library dependencies                         | -
-OpenVDB LOD             | Core Library dependencies                         | -
-OpenVDB Render          | Core Library dependencies                         | OpenEXR, IlmBase, libpng
-OpenVDB View            | Core Library dependencies, OpenGL, GLFW3, GLEW*   | -
-OpenVDB Python          | Core Library dependencies, Python, Boost::python  | Boost::numpy, NumPy
-OpenVDB AX              | Core Library dependencies, LLVM                   | Bison, Flex
-NanoVDB                 | -                                                 | Core Library, CUDA, TBB, Blosc, ZLib
-OpenVDB UnitTests       | Core Library dependencies, GoogleTest             | CppUnit**
-OpenVDB Documentation   | Doxygen                                           | -
+Component               | Requirements                                    | Optional
+----------------------- | ----------------------------------------------- | --------
+OpenVDB Core Library    | CMake, C++17 compiler, TBB::tbb, Boost::headers | Blosc, ZLib, Log4cplus, IlmBase::Half, Boost::iostream
+OpenVDB Print           | Core Library dependencies                       | -
+OpenVDB LOD             | Core Library dependencies                       | -
+OpenVDB Render          | Core Library dependencies                       | OpenEXR, IlmBase, libpng
+OpenVDB View            | Core Library dependencies, OpenGL, GLFW3, GLEW* | -
+OpenVDB Python          | Core Library dependencies, Python, PyBind11     | NumPy
+OpenVDB AX              | Core Library dependencies, LLVM                 | Bison, Flex
+NanoVDB                 | -                                               | Core Library, CUDA, TBB, Blosc, ZLib
+OpenVDB UnitTests       | Core Library dependencies, GoogleTest           | CppUnit**
+OpenVDB Documentation   | Doxygen                                         | -
 
  - @b * GLEW is only required for building the vdb_view binary on Windows.
  - @b ** CppUnit is only required for building the AX unit tests.
@@ -62,15 +62,16 @@ GCC            | 9.3.1   | 9.3.1       | C++ 17 Compiler: The GNU Compiler Colle
 Clang          | 5.0     | Latest      | C++ 17 Compiler: A C language family frontend for LLVM            | Y       | Y        | https://clang.llvm.org
 Intel ICC      | 19      | Latest      | C++ 17 Compiler: Intels C++ Compiler                              | Y       | Y        | https://software.intel.com/en-us/c-compilers
 MSVC           | 19.28   | Latest      | C++ 17 Compiler: Microsoft Visual C++ Compiler                    | Y       | Y        | https://visualstudio.microsoft.com/vs
-IlmBase        | 2.4     | 3.1         | Used half precision floating points and EXR serialization support | Y       | Y        | http://www.openexr.com
+IlmBase        | 2.4     | Removed     | Used half precision floating points and EXR serialization support | Y       | Y        | http://www.openexr.com
 OpenEXR        | 2.4     | 3.1         | EXR serialization support                                         | Y       | Y        | http://www.openexr.com
 TBB            | 2020.2  | 2020.3      | 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.73    | 1.76        | Components: headers, iostreams, python, numpy                     | Y       | Y        | https://www.boost.org
+Boost          | 1.73    | 1.76        | Components: headers, iostreams                                    | Y       | Y        | https://www.boost.org
 LLVM           | 10.0.0  | 10.0.0*     | Target-independent code generation                                | Y       | Y        | https://llvm.org/
 Bison          | 3.0.0   | 3.7.0       | General-purpose parser generator                                  | Y       | Y        | https://www.gnu.org/software/gcc
 Flex           | 2.6.0   | 2.6.4       | Fast lexical analyzer generator                                   | Y       | Y        | https://github.com/westes/flex
-Python         | 3.7     | 3.7         | The python interpreter and libraries for C++/python bindings      | Y       | Y        | https://www.python.org
+Python         | 3.7     | 3.7         | The python interpreter and libraries                              | Y       | Y        | https://www.python.org
+PyBind11       | 2.9.1   | Latest      | C++/python bindings                                               | Y       | Y        | https://pybind11.readthedocs.io
 NumPy          | 1.19.0  | 1.20.0      | Scientific computing with Python                                  | Y       | Y        | http://www.numpy.org
 GoogleTest     | 1.10    | Latest      | A unit testing framework module for C++                           | Y       | Y        | https://github.com/google/googletest
 CppUnit        | 1.10    | Latest      | A unit testing framework module for C++                           | N       | Y        | https://freedesktop.org/wiki/Software/cppunit
@@ -95,14 +96,6 @@ Doxygen        | 1.8.8   | 1.8.11      | Documentation generation from C++
  - @b GLFW: Crash with GLFW 3.2.1 when used with EGL on Linux. OpenVDB View may
  segfault on closure. Fixed in GLFW 3.3
 
- - @b Boost 1.66/1.67 + @b Python3 + @b NumPy: Known issue on UNIX systems
- which can cause the below python runtime error. Our minimum supported boost
- version now superseeds this issue:
-
-@code{.sh}
-RuntimeError: FATAL: module compiled as little endian, but detected different endianness at runtime.
-@endcode
-
  - @b Blosc: OpenVDB has historically used an old version of blosc (1.5.0) to
  serialize .vdb files. OpenVDB has recently moved to a new blosc version minimum
  of 1.17.0. We have tested a range of blosc versions and found that the following
@@ -127,6 +120,23 @@ required OpenVDB dependencies.
 
 @subsection depUsingAptGet Using UNIX apt-get
 
+You can use apt to automatically install required packages. Note that different
+Ubuntu distributions will have different versions available. You can use apt
+pinning to request newer versions of specific package from later distributions
+if the required version isn't available by default (see
+[man apt_preferences](https://linux.die.net/man/5/apt_preferences)). For
+example, the below settings will request TBB specifically from Ubuntu 22.04
+(Jammy).
+
+@code{.sh}
+Package: libtbb-dev
+Pin: release n=jammy
+Pin-Priority: 990
+@endcode
+
+Alternatively you can install any missing dependencies manually or through
+other package managers.
+
 @b Note:CppUnit is unavailable using apt-get. See the other package manager
 methods or the [manual installation](@ref depManInstall) options.
 
@@ -141,8 +151,7 @@ apt-get install libblosc-dev            # Blosc
 # AX
 apt-get install llvm-10-dev              # LLVM
 # Python
-apt-get install libboost-python-dev     # Boost::python
-apt-get install libboost-numpy-dev      # Boost::numpy
+apt-get install pybind11-dev            # Python
 apt-get install python-dev              # Python
 apt-get install python-numpy            # NumPy
 # Optional
@@ -175,7 +184,7 @@ brew install c-blosc                   # blosc
 # AX
 brew install llvm                      # LLVM
 # Python
-brew install boost-python              # Boost-python
+brew install pybind11                  # PyBind11
 brew install python                    # Python
 brew install numpy                     # NumPy
 # Unit Tests

openvdb/openvdb/python/CMakeLists.txt

@@ -107,7 +107,7 @@ endif()
 
 # Make sure find_package(Python) is only ever invoked once with all required components
 find_package(Python COMPONENTS ${OPENVDB_PYTHON_REQUIRED_COMPONENTS})
-find_package(pybind11 REQUIRED)
+find_package(pybind11 ${MINIMUM_PYBIND_VERSION} REQUIRED)
 
 openvdb_check_python_version(Python::Module
   "${Python_VERSION}"

openvdb/openvdb/python/pyGrid.h

@@ -385,7 +385,7 @@ inline ArrayDimVec
 arrayDimensions(const py::array& array)
 {
     ArrayDimVec dims;
-    for (int i = 0, N = array.ndim(); i < N; ++i) {
+    for (size_t i = 0, N = array.ndim(); i < N; ++i) {
         dims.push_back(array.shape(i));
     }
     return dims;
@@ -812,7 +812,7 @@ meshToLevelSet(py::array_t<float> pointsObj, py::array_t<Index32> trianglesObj,
 
 template<typename GridType, typename std::enable_if_t<!std::is_scalar<typename GridType::ValueType>::value>* = nullptr>
 inline std::tuple<py::array_t<float>, py::array_t<Index32> >
-volumeToQuadMesh(const GridType& grid, double isovalue)
+volumeToQuadMesh(const GridType&, double)
 {
     OPENVDB_THROW(TypeError, "volume to mesh conversion is supported only for scalar grids");
 }
@@ -839,7 +839,7 @@ volumeToQuadMesh(const GridType& grid, double isovalue)
 
 template<typename GridType, typename std::enable_if_t<!std::is_scalar<typename GridType::ValueType>::value>* = nullptr>
 inline std::tuple<py::array_t<float>, py::array_t<Index32>, py::array_t<Index32> >
-volumeToMesh(const GridType& grid, double isovalue, double adaptivity)
+volumeToMesh(const GridType&, double, double)
 {
     OPENVDB_THROW(TypeError, "volume to mesh conversion is supported only for scalar grids");
 }

pendingchanges/pybind11.txt

@@ -1,2 +1,3 @@
 Python:
     - OpenVDB Python bindings are now implemented using pybind11 instead of Boost.Python.
+    [Contributed by Matthew Cong]