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 official supported platforms (see Supported environments for more information).

  • Python 3.10 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 22.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 has been identified as a required package that might not be installed in basic Ubuntu 22.04 systems.

The command line code sample below shows how to install libgomp1:

sudo apt update
sudo apt install --no-install-recommends libgomp1 -y

Windows

There are no known additional dependencies to pre-install on Windows.

Installation

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 run time environment. The only requirement is that it be installed into a supported environment running Python 3.10, 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.0.0-cp310-cp310-linux_x86_64.whl