Installation¶
Prerequisites¶
Familiarity with Python package installation tools. See Python installation tool recommendations for more information.
The system into which PIX4Dengine SDK is to be installed must be one of the officially supported platforms (see Supported Environments for more information).
A supported version of Python and a tool capable of installing Python wheel packages are installed on the system.
Pre-install dependencies for given platform (see below).
Pre-install dependencies¶
Linux/Ubuntu 26.04¶
Although an effort has been made to produce a largely self-contained Linux wheel, it may be necessary to pre-install some packages before PIX4Dengine SDK. This is heavily dependent on the Ubuntu installation itself, but libgomp1 and libxml2-16 have been identified as required packages that might not be installed on basic Ubuntu 26.04 systems.
The command line code sample below shows how to install the system dependencies:
sudo apt update
sudo apt install --no-install-recommends libgomp1 libxml2-16 -y
Windows¶
There are no known additional dependencies to pre-install on Windows.
Installation steps¶
PIX4Dengine SDK is packaged as a Python wheel for each one of the supported environments, giving the user some flexibility both in the method of installation and the runtime environment. The only requirement is that it be installed into a supported environment running a supported version of Python, and that any pre-install dependencies have been met.
In what follows, the pip tool is used to illustrate how to install the package. For simplicity, it is assumed that a virtualenv has been used to create an isolated Python environment into which PIX4Dengine SDK shall be installed. These two tools are common, but not unique, and not a strong requirement for installation. For more information on these and alternative installation tools, see Python installation tool recommendations.
pip install pix4dvortex-2.21.0-cp314-cp314-linux_x86_64.whl
DJI Thermal SDK¶
In order to fully support DJI thermal cameras, the DJI Thermal SDK needs to be downloaded by the user and unpacked at a specific location where PIX4Dengine SDK can find it. Without this SDK, thermal orthomosaic produced from DJI cameras will not have correct temperatures; instead, the units of the output will be raw values in an arbitrary unit.
To simplify the installation a bash script is provided for Linux and a
PowerShell script is provided for Windows.
Both require a Python executable and PIX4Dengine SDK to be available in the environment to find out the installation location.