Install

• C++ Build and install transparently across platforms using the cmake build CLI and cmake install CLI, respectively.

  Our CMake project exposes the following build targets

  Target	Description
  PhysicsBasedAnimationToolkit_PhysicsBasedAnimationToolkit	The PBA Toolkit library.
  PhysicsBasedAnimationToolkit_Tests	The test executable, using doctest.
  PhysicsBasedAnimationToolkit_Python	PBAT's Python extension module, using nanobind.

  For example, to build tests, run

  cmake --build <path/to/build/folder> --target PhysicsBasedAnimationToolkit_Tests --config Release

  To install PhysicsBasedAnimationToolkit locally, run

  cd path/to/PhysicsBasedAnimationToolkit
  cmake -S . -B build -D<option>=<value> ...
  cmake --install build --config Release

• Python

  For a local installation, which builds from source, our Python bindings build relies on Scikit-build-core, which relies on CMake's install mechanism. As such, you can configure the installation as you typically would when using the CMake CLI directly, by now passing the corresponding CMake arguments in pip's config-settings parameter (refer to the Scikit-build-core documentation for the relevant parameters). See our pyinstall workflow for working examples of building from source on Linux, MacOS and Windows. Then, assuming that external dependencies are found via CMake's find_package, you can build and install our Python package pbatoolkit locally and get the most up to date features.

  Note

  Consider using a Python virtual environment for this step.

  As an example, assuming use of vcpkg for external dependency management with VCPKG_ROOT=path/to/vcpkg set as an environment variable, run

  pip install . --config-settings=cmake.args="--preset=pip-cuda" -v

  on the command line to build pbatoolkit from source with GPU algorithms included. Additional environment variables (i.e. CUDA_PATH) and/or CMake variables (i.e. CMAKE_CUDA_COMPILER) may be required to be set in order for CMake to correctly discover and compile against your targeted local CUDA installation. Refer to the CMake documentation for more details.

Previous	Next
Configuration	User guide