Build from source#
Building from source is required to use the latest features or to work on new features or pull requests. The process is simple.
Use Git to fetch the latest version.
git clone --depth 10 https://github.com/isaksamsten/wildboar.git
Install a c-compiler for your operating system.
First install build tools for Visual Studio 2019
Note
You do not need to install Visual Studio 2019. You only need the Build Tools for Visual Studio 2019 which you can find under All downloads and then Tools for Visual Studio 2019.
For 64-bit Python, configure the build environment by running the following commands in cmd console.
SET DISTUTILS_USE_SDK=1 "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvarsall.bat" x64
Note
Replace the path with the install path of Visual Studio Build tools.
Install the macOS command line tools
xcode-select --installInstall build dependencies for your distribution.
For Debian-based operating systems, e.g. Ubuntu:
apt install build-essential python3-dev python3-pip
Install uv and enter the repository:
cd wildboar uv sync
This creates
.venv, installs Wildboar in editable mode, and installs the development dependencies. On systems with Make,make depsruns the same command. Run it again when dependencies change.
Incremental development builds#
After editing Cython code, rebuild extensions without reinstalling the package:
make build
Run tests with:
make test
To build the documentation, run make docs-deps followed by make docs.
Run make docs-deps again after syncing if uv removed the documentation tools.
Build options#
The environment variable WILDBOAR_BUILD controls compiler options. Supported
values are default, debug and optimize. For example:
WILDBOAR_BUILD=optimize make rebuild
Use make rebuild when changing compiler flags or build mode.
Additional build_ext options can be passed through Make, for example:
make build BUILD_EXT_ARGS="--parallel 4"
Regular installation#
If you only want to install Wildboar from source rather than develop it, use:
uv pip install .