Installation#
We provide two versions of the Jacobi motion library,
a Cloud version that out-sources the heavy motion planning calculations to our servers, is easier to setup, and always uses the latest advances in our algorithms,
and an On-prem version for commerical use-cases requiring highest reliability, lowest latency and more advanced real-time capabilities.
In case you are wondering which version you want, you’re probably looking for the cloud version which is free to install.
The Jacobi library is available on Linux, for C++ (17 and later) and Python (3.8 and later).
Installation
The Jacobi Cloud Python package can be installed from PyPI via
pip install jacobi-motion
In case no package could be found, make sure to upgrade pip to the latest available version via pip install pip --upgrade.
License
The Cloud version requires an API key for authentication that you can access at your user account at account.jacobirobotics.com. You can pass this to the motion library by setting the JACOBI_API_KEY and JACOBI_API_SECRET environment variable.
Installation
The pre-compiled Jacobi motion library can be downloaded as a Debian package on our release page at account.jacobirobotics.com for Linux and the x86 architecture. Please let us know if you have any other requirements.
Then, you can install the Debian package via
sudo apt install ./jacobi-motion-*.deb
You can then easily integrate the Jacobi motion library into your CMake build process by using
find_package(jacobi-motion)
# ...
target_link_libraries(<your application> PUBLIC jacobi::motion)
in your CMakeLists.txt.
License
The Cloud version requires an API key for authentication that you can access at your user account at account.jacobirobotics.com. You can then set the key and secret value to the JACOBI_API_KEY and JACOBI_API_SECRET environment variable.
Installation
Please find all downloads in your user account at account.jacobirobotics.com. Choose the corresponding Python Wheel file for your Python version and architecture, and install via
pip install <...>.whl
Please make sure to uninstall the Cloud version before.
License
The On-prem version requires a license key that is, if not specififed otherwise, tied to a specific computer. To get started, get the token from the license that you want to activate at account.jacobirobotics.com and run
jacobi-get-license <your-license-token> --name my-robot
to activate your license. Feel free to pass an optional name argument to simplify the license handling in case of multiple computers. This will download the key file and saves it on your local machine. If you want to move the key, feel free to specify the new location via the JACOBI_LICENSE_DIRECTORY environment variable.
Installation
Please find all downloads in your user account at account.jacobirobotics.com. You can install the Debian package via
sudo apt install ./jacobi-motion-*.deb
You can then easily integrate the Jacobi motion library into your CMake build process by using
find_package(jacobi-motion)
# ...
target_link_libraries(<your application> PUBLIC jacobi::motion)
in your CMakeLists.txt.
License
The On-prem version requires a license key that is, if not specififed otherwise, tied to a specific computer. To get started, get the token from the license that you want to activate at account.jacobirobotics.com and run
./jacobi-get-license <your-license-token> --name my-robot
to activate your license. Feel free to pass an optional name argument to simplify the license handling in case of multiple computers. This will download the key file and saves it on your local machine. If you want to move the key, feel free to specify the new location via the JACOBI_LICENSE_DIRECTORY environment variable.