Installation

Python scripts using the imperix library can can be executed via Cockpit’s built-in script launcher, without the need of installing additional software.

Version compatibility

Each imperix SDK release is built for one MAJOR.MINOR series of the library:

imperix library

imperix SDK

Download

0.2.x

2026.3 beta 2

imperix_python_library_v0.2.0.zip

0.1.x

2026.3 beta 1

imperix_python_library_v0.1.3.zip

If the library and the SDK do not match:

  • Different MINOR: scripts still run and a warning is shown. Features added in the newer of the two are unavailable until both match.

  • Different MAJOR: the library cannot be used with that SDK and scripts stop with an error. Install the library series listed for the installed SDK, or update the SDK.

Installing the library

To run these scripts outside of Cockpit (e.g., via the command line or VS Code), install the imperix Python library as outlined below.

Prerequisites:

  1. imperix ACG SDK or CPP SDK version 2026.3 or later (download).

  2. Python version 3.11 or later (download).

Steps:

  1. Download the imperix Python library: imperix_python_library_v0.2.0.zip

  2. Install the library using pip by pointing it to your downloaded file:

python -m pip install "C:\path\to\imperix_python_library_v0.2.0.zip"

Note

For a more detailed walkthrough, see the Getting started guide.