Installation

To install Zivid Motion, install the Debian package (C++) or the Python wheel (Python), then verify the installation succeeded, as shown below for each language. Zivid Motion is available as a Python API and C++ API; other language support may be available in the future. Before installing, check the System Requirements for the supported OS, CPU, and GPU.

The Zivid Motion files are delivered to you directly from the Zivid team. Contact us at customersuccess@zivid.com if you have not received them.

C++

After receiving the Zivid Motion files, install the provided Debian package, which contains the header files, shared library, and CMake module for Zivid Motion.

$ sudo apt install ./zivid-motion-*.deb

To verify that the installation succeeded, you can try to use Zivid Motion with CMake.

find_package(ZividMotion COMPONENTS Motion REQUIRED)
target_link_libraries(your_target PRIVATE Zivid::Motion)

Python

After receiving the Zivid Motion files, install the provided python wheel. The wheel is self-contained, so this is all you need to run Zivid Motion from Python.

$ pip install zivid_pythonmotion-*.whl

A single wheel covers every CPython version Zivid Motion supports, as seen in the filename of the wheel itself. A wheel tagged cp310.cp313 installs on both CPython 3.10 and CPython 3.13. See Troubleshooting if pip rejects the wheel.

To verify that the installation succeeded, start Python and make sure you can import Zivid Motion.

>>> import zividmotion
>>> help(zividmotion)

After installing Zivid Motion, you can get started with the Quickstart Guide. Once the cell data from that guide is installed, the Visualize Cell sample is a good end-to-end check that Zivid Motion works on your machine.