Installation

InsarViz is packaged as a standard package on PyPI, which means it should be very simple to install.

Automatic Install

The simplest way to install InsarViz is by downloading and running the install script, or just with the following command :

bash <(curl -sL https://deformvis.gricad-pages.univ-grenoble-alpes.fr/insarviz/latest/insarviz_install.sh)

This command must be pasted into the command line (follow these instructions to open it)

powershell -executionPolicy bypass -c "irm https://deformvis.gricad-pages.univ-grenoble-alpes.fr/insarviz/latest/insarviz_install.ps1 | iex"

On Windows and MacOS, a shortcut will be created during installation (on the desktop for Windows, and in the “Applications” folder in MacOS).

You can also run InsarViz directly from the command-line, by running ts_viz.

Manual Install

We recommend using UV to install InsarViz, as it has been tested on all major platforms (Windows, Mac and Linux). You can install UV by following the instructions on this page

Set up the environment

It is recommended to install InsarViz in a virtual environment, so as to minimize the impact that it may have on your system.

Don’t worry though, creating a virtual environment is very simple. First, you need to choose a directory where you want the install to take place (in this tutorial, we’ll assume the directory to be $HOME/install/InsarViz). Then, you need to run the following commands :

# change to whatever folder you like
INSARVIZ_ENV=$HOME/install/InsarViz
mkdir -p "$INSARVIZ_ENV"
cd "$INSARVIZ_ENV"
uv venv --python 3.13

Install InsarViz

Once your environment is created, you can choose the version you want to install.

Install the latest stable version (usually what you need)

cd "$INSARVIZ_ENV"
uv pip install insarviz

Install a specific version, if your workflow needs it

# InsarViz versions can be found here :
#   https://pypi.org/project/InsarViz/#history
INSARVIZ_VERSION=2.4.2.4
cd "$INSARVIZ_ENV"
uv pip install insarviz==$INSARVIZ_VERSION

To try out new features, or when bug fixes aren’t yet pushed to production

# Choose a source reference ('master' is the latest development version)
INSARVIZ_REF=master
cd "$INSARVIZ_ENV"
uv pip install git+https://gricad-gitlab.univ-grenoble-alpes.fr/deformvis/insarviz@$INSARVIZ_REF

Run InsarViz

Once installed, you can start InsarViz.

cd "$INSARVIZ_ENV"
uv run ts_viz # Open an empty project

Or if you want to open a dataset :

cd "$INSARVIZ_ENV"
uv run ts_viz -i DATASET.tiff # change with the path to your time series

Developer installation

If you want to contribute to InsarViz, or simply adapt it to your needs, you can also run it from source.

InsarViz is versioned with Git, so you need to install that before continuing.

Download the source code using git (first navigate to the destination folder):

git clone https://gricad-gitlab.univ-grenoble-alpes.fr/deformvis/insarviz

git clone git@gricad-gitlab.univ-grenoble-alpes.fr:deformvis/insarviz.git

git clone https://gricad-gitlab.univ-grenoble-alpes.fr/deformvis/insarviz -b beta

Once you’ve modified the source, you can test your changes by simply running (in your project directory) :

uv run ts_viz ...