Skip to content

Install

Panoramax CLI can be installed using various methods:

Geovisio CLI is compatible with all Python versions >= 3.9.

Tip

If your system does not support python 3.9, you can use a tool like pyenv or uv to install a newer python version.

On Windows, just download the latest Windows executable and open a shell in the download directory (you can do that by typing cmd in the explorer opened in the directory).

Then, simply run:

panoramax_cli-win-amd64.exe --help

Note

Linux binary has been built for AMD64. They are built using Ubuntu 22.04, so they should work for all newer versions. For older version though, there might be libstdc++ incompatibilities; if you encounter that problem, you can update libstdc++ or install using PyPi.

Download the latest Linux binary, then in the download directory:

chmod u+x panoramax_cli-linux-amd64
./panoramax_cli-linux-amd64 --help

Optionally, you can put this in /usr/local/bin (if it's in your path) for a simpler use:

chmod u+x panoramax_cli-linux-amd64
mv panoramax_cli-linux-amd64 /usr/local/bin/panoramax_cli

panoramax_cli --help

Just run this command:

pip install panoramax_cli

You should then be able to use the CLI tool with the name panoramax_cli:

panoramax_cli --help

Alternatively, you can use pipx if you want all the script dependencies to be in a custom virtual env.

If you choose to install pipx, then run:

pipx install panoramax_cli

uv is a really efficient tool to handle python programs.

You just need to install uv, following their documentation.

Then you can just run:

uvx panoramax_cli --help

It will handle the installation of the python package, the virtual env and will run panoramax_cli.

Download the repository:

git clone https://gitlab.com/panoramax/clients/cli.git panoramax_cli
cd panoramax_cli/

To avoid conflicts, it's considered a good practice to create a virtual environment (or virtualenv). To do so, launch the following commands:

# Create the virtual environment in a folder named "env"
python3 -m venv env

# Launches utilities to make environment available in your Bash
source ./env/bin/activate

Then, install the Panoramax CLI dependencies using pip:

pip install -e .

You can also install the dev and docs dependencies if necessary (to have lints, format, tests...):

pip install -e .[dev,docs]

Then, you can use the panoramax_cli command:

panoramax_cli --help

Note

Panoramax CLI has had numerous changes since its version 1.0.0, which makes it compatible only with API supporting Upload Set system for sending pictures. Panoramax API starts supporting Upload Set on version 2.7. If you're working with an older Panoramax API, or using a third-party STAC API not compatible with Upload Sets, you can use older version of CLI:

pip install panoramax_cli=0.3.13

However, it's better to encourage all API administrators to move to a recent Panoramax API version, or make their third-party API compatible with Upload Sets.

Updating an existing installation

Updating panoramax_cli depends on the installation method:

On Windows, just download the latest Windows executable and open a shell in the download directory (you can do that by typing cmd in the explorer opened in the directory).

Warning

If there was a previous executable in the directory, make sure to rename or delete the old panoramax_cli-win-amd64.exe file. Else the new file might be named like panoramax_cli-win-amd64(1).exe

Then, simply run:

panoramax_cli-win-amd64.exe --help

Download the latest Linux binary.

Warning

If there was a previous executable in the directory, make sure to rename or delete the old panoramax_cli-linux-amd64 file. Else the new file might be named like `panoramax_cli-linux-amd64(1)

Then in the download directory:

chmod u+x panoramax_cli-linux-amd64
./panoramax_cli-linux-amd64 --help

Optionally, you can put this in /usr/local/bin (if it's in your path) for a simpler use:

chmod u+x panoramax_cli-linux-amd64
mv panoramax_cli-linux-amd64 /usr/local/bin/panoramax_cli

panoramax_cli --help

Just run this command:

pip install --upgrade panoramax_cli

With uv updating the package is as simple as:

uvx panoramax_cli@latest --help

It will handle the installation and update of the python package, the virtual env and will run panoramax_cli.

In the previously cloned git repository panoramax_cli, update the sources:

git pull --rebase

Activate the virtual env:

source ./env/bin/activate

Then, install the Panoramax CLI dependencies using pip:

pip install --upgrade -e .