cuvis.python

cuvis.python is the python wrapper for the Cuvis SDK written in C (available here).

• Website: https://www.cubert-hyperspectral.com/
• Source code: https://github.com/cubert-hyperspectral/
• Support: http://support.cubert-hyperspectral.com/

This wrapper enables operating Cubert GmbH Hyperspectral Cameras, as well as, analyzing data directly from the corporate data format(s) within python. This wrapper provides an object-oriented full representation of the basic C SDK capabilities and python return variable formats based on commonly used modules, like dictionaries, datetime or numpy objects.

For other supported program languages, please have a look at the source code page.

Installation

Cuvis C SDK
Download and install the lastest Cuvis C SDK.
Link: Cuvis C SDK

Prerequisites

First, you need to install the Cuvis C SDK from here. The installation registers the installation path in the environment, which the python wrapper is linked to.

⚠️ If the C SDK is reinstalled into another directory later on, the linkage breaks and the python wrapper might stop working.

Via pip

If you wish to use cuvis within another project, from within your project environment, run

pip install cuvis

or add cuvis to your project requirements.txt or setup.py. We currently provide pre-compiled binaries for Python 3.9, 3.10, 3.11, 3.12, 3.13 and 3.14 for Windows, Ubuntu 20.04 and Ubuntu 22.04 (all 64-bit).

To access the newest python cuvis version (for use with SDK beta versions, etc) you can install it with

pip install cuvis --pre

Via repository

If you wish to download and use the newest development cuvis locally, clone the git repository

git clone git@github.com:cubert-hyperspectral/cuvis.python.git

and install the wrapper locally.

If you wish to use the version compatible to the available Cuvis SDK download, check out the version on the site above and use the respective release branch (e.g. release/v3.2).

For building the python bindings refer to cuvis.pyil.

Versioning

Wrapper versions are GENERATION.MAJOR.MINOR.PATCH. GENERATION.MAJOR.MINOR is the Cuvis C SDK release this wrapper targets, and PATCH counts wrapper-only revisions against that same SDK; 3.5.3.1 is a wrapper fix on top of 3.5.3.0, both for SDK 3.5.3.

main is the trunk and points at the latest released wrapper state; every release is a v* tag on one of its commits. Every release is listed in CHANGELOG.md. The scheme and the release process are documented in CONTRIBUTING.md.

How to ...

Getting started

We provide an additional example repository here, covering some basic applications.

Further, we provide a set of example measurements to explore here. These measurements are also used by the examples mentioned above.

Getting involved

cuvis.hub welcomes your enthusiasm and expertise!

With providing our SDK wrappers on GitHub, we aim for a community-driven open source application development by a diverse group of contributors. Cubert GmbH aims for creating an open, inclusive, and positive community. Feel free to branch/fork this repository for later merge requests, open issues or point us to your application specific projects. Before opening a pull request, please read CONTRIBUTING.md; it covers the branch model, the version scheme, the changelog conventions and the checks CI runs. Contact us, if you want your open source project to be included and shared on this hub; either if you search for direct support, collaborators or any other input or simply want your project being used by this community. We ourselves try to expand the code base with further more specific applications using our wrappers to provide starting points for research projects, embedders or other users.

Getting help

Directly code related issues can be posted here on the GitHub page, other, more general and application related issues should be directed to the aforementioned Cubert GmbH support page.