Installation

Recommended Python distribution

We recommend to use uv (https://docs.astral.sh/uv/) to manage the project. First download uv following the installation step provided by uv.

Then you should download the code, then install dependencies and finally run the code.

Code download

You can download the code using git. The following command will copy the code together with the git archive that will ease the update:

git clone  https://gitlab.in2p3.fr/ForMaTer/ground_deformation.git

If you dont want the whole history (e.g. in order to have a smaller disk footprint), you can get it like this

git clone --depth 1 https://gitlab.in2p3.fr/ForMaTer/ground_deformation.git

You can also directly download it form the web site https://gitlab.in2p3.fr/ForMaTer/ground_deformation (hit the “clone” button and “download source code”).

Install the dependencies

You should first create the virtual env, then get the dependencies. This can be achieved in two uv steps.

# go to the directory where the code is
cd ground_deformation/
# create a virtual env using python 3.11
uv venv --python 3.11 --prompt ground_deformation --relocatable --link-mode hardlink
# install ground deformation and its dependencies
uv pip install .
# install the kernel with name "ground_deformation"
uv run ipython kernel install --user --name="ground_deformation"

You should now be in position to run the code.

Run the code

# in a "classical" virtual manner
source .venv/bin/activate
jupyter-lab
# or using uv
uv run --with jupyter jupyter lab

A new tab should open in your navigator.