Installation

Prerequisites

Before installing, make sure your system meets the following requirements:

Operating System

• Windows 8 or higher

• macOS

• Debian-based distributions (e.g., Debian, Ubuntu)

Hardware

• CPU: x86_64 processor

• RAM: 4 GB minimum (8 GB recommended)

• Disk: 50 GB free space

• GPU: Optional, required only for hardware acceleration

Software

• Python 3.9 installed

• pip package manager available

• Git (optional, for repository installation)

Internet Connection

• Required for dependencies, station data, and metadata downloads.

Note: You can streamline installation by using a requirements file and a package manager like pip or conda.

Installation Steps

1. Clone the Repository

   1. Without a gitlab account:

      git clone https://gricad-gitlab.univ-grenoble-alpes.fr/isterre-cycle/rringg.git
      

   2. With a gitlab account (ssh):

      git clone git@gricad-gitlab.univ-grenoble-alpes.fr:isterre-cycle/rringg.git
      

   3. You can specify a branch using the option -b, for example the dev branch::

      git clone git@gricad-gitlab.univ-grenoble-alpes.fr:isterre-cycle/rringg.git -b dev
      

2. Create Environment and Install Dependencies

   Preliminary Setup (Windows Only)

   1. Install Git Bash

      Download and install Git Bash for Windows.

      Recommended options during installation:

      • Enable “Add Git Bash to PATH”

      • Enable “Create desktop shortcut” (optional but convenient)

   2. Install Miniconda (recommended) and launch Git Bash

      • Download and install the latest version of Miniconda for Windows.

      • Open Git Bash from the Start Menu or using the desktop shortcut if you created one during installation.

   3. Activate the Conda base environment

      In Git Bash, run:

      source activate base
      

      If the above command doesn’t work, try:

      conda activate base
      

   Using Anaconda

   After installing Miniconda (recommended), or Anaconda if you haven’t already, you can create and activate the environment using one of the following methods:

   1. Manual setup (recommended method):

      conda create -n rringg-env python=3.9.18
      conda activate rringg-env
      conda install -c conda-forge gdal=3.5.3
      pip install -r requirements.txt
      pip install pygdal==3.5.3.11 (Optional :: this last command is not in the requirement because it may not be installed.)
      

   2. From an environment file:

      conda env create -f environment.yml
      conda activate rringg-env
      

   Without Anaconda

   If you prefer not to use Anaconda, follow these steps to create and activate a virtual environment:

   1. Create and activate the environment:

      python -m venv rringg-env
      

      On Unix

      source rringg-env/bin/activate
      

      On Windows

      source rringg-env/Scripts/activate
      

   2. Install the required dependencies:

      pip install -r requirements.txt
      

   Note

   • We strongly recommend using Conda for installation.

   • Ensure GDAL is properly installed before proceeding with the installation of the requirements. Use the command gdalinfo --version to verify.

   • Make sure you have at least GDAL version 3.5.3 installed, as the tool does not work correctly with versions 2.*.

   • If your GDAL version is higher than 3.5.3, install the corresponding version of pygdal. Failure to do so may result in installation errors.

   • To force the reinstallation of libraries, you can add --ignore-installed at the end of the installation command.

3. Run the Program to Verify the Installation

   pytest ./tests/test_installation.py