Getting Started | PY

Installation

Install trueform via pip.

Requirements

  • Python 3.8 or later

pip install

pip install trueform

This installs:

  • Python bindings — full trueform API for Python
  • C++ headers — header-only library for C++ projects
For C++ CMake integration from the pip package, see C++ Installation.

Building from Source

For development or unsupported platforms:

git clone https://github.com/xlabmedical/trueform.git
cd trueform
CMAKE_BUILD_PARALLEL_LEVEL=8 pip wheel . -w dist
pip install dist/trueform-*.whl

Or using CMake directly:

cmake -B build -DTF_BUILD_PYTHON=ON
cmake --build build --parallel --target trueform_python
pip install ./build/python

Verify

import trueform as tf

print(tf.__version__)