Installation

Code download

First, download the source code, typically using git:

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

Environment setup

  • With Anaconda

We recommend you install the ground_deformation tool in a virtual environment. If you have installed the Anaconda distribution, navigate to within the top-level ground_deformation folder and create a conda environment with the required dependencies using :

conda env create -f environment.yaml

And activate it:

conda activate ground_deformation-env

  • Without Anaconda

Without Anaconda, create an virtual environment, activate it and install the required packages using the following commands:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Installation type

Finally, install the ground_deformation module within your virtual environment. If you do not want to modify the source code, follow the Regular installation instructions. If you would like to be able to modify the code, follow the Developper install instructions.

  • Regular installation

Installing ground_deformation in a virtual environment, or system-wide, is just a one-line command:

pip install .

  • Developper installation

If you intend to change the source code, you should install the tool in a editable mode:

pip install -e .

Test your installation

You can check your installation by doing:

CODE TO RUN

This should print the help message. If not, your install failed.