User Guide¶

To configure sDRIPS for your area of interest, follow the steps in the Installation section. sDRIPS is platform-independent and can be installed on Windows, Linux, or macOS. Its modular architecture offers flexibility through configuration files.

• Use the Standard Version for most applications. This version contains the complete workflow and is recommended for general use.
• Use the Developer Version if you plan to extend sDRIPS by adding custom modules or adapting it for research applications by tweaking the source code. Detailed instructions for the developer version can be found in Developer Verison.

Requirements¶

To setup the sDRIPS, following things are required:

• Anaconda/Miniconda - To install the appropriate distribution for your operating system, click here.
• Credentials for Google Earth Engine - Required for processing satellite imagery. If you do not have credentials, follow the Getting Ready.
• Credentials to download IMERG-GPM precipitation data - Required for downloading precipitation data via the NASA Precipitation Processing System (PPS). Instructions are provided in the Getting Ready guide.

Installation¶

Step 1:
Create an empty project directory.

mkdir ./sdrips_project

Step 2:
Create a conda environment

conda create -n sdrips_env python=3.11 pip

Step 3:
Activate your virtual environment using conda.

conda activate sdrips_env

Step 4:
Install sDRIPS using either pip (currently recommended) or mamba (under development).
Using pip:

pip install sdrips

Using mamba (under development):

conda install mamba -c conda-forge
mamba install sdrips -c conda-forge

Initialization¶

Every new sDRIPS project must be initialized. This step generates the configuration files required to run workflows.

Run the following command in your project directory (e.g., sdrips_project):

sdrips init -d ./sdrips_project

Initialization creates four configuration files in the config_files/ directory. These files form the core of sDRIPS, storing user inputs and controlling workflow execution. At this stage, add your credential details (IMERG-GPM PPS account and Google Earth Engine service account, if applicable) to the secrets.yaml file.

Testing¶

After installation, you can verify whether sDRIPS has been set up correctly. Running this test suite not only ensures a successful installation but also helps detect any issues in the pipeline when new functionality is introduced.

sDRIPS supports two testing modes for advisory generation:

1. Satellite + weather model data – Runs the functional logic using satellite datasets in combination with numerical weather model data.

2. Satellite + weather model data (bias-corrected with in-situ sensors) – Extends the first mode by integrating in-situ observations to bias-correct the numerical model data before estimating evapotranspiration and generating advisories.

For more in-depth information on testing for developers, refer to the Developer Version.

Running Tests

sdrips test -d ./tests

or

sdrips test -d ./tests -s

Expected Output

A successful installation produces output similar to the following:

Tests (3 Tests) for ET based raster outputs completed successfully.

Checks (2 Checks) for precipitation raster outputs completed successfully.

Tests (2 Tests) for CSV outputs completed successfully.

All tests passed!

or

Tests (3 Tests) for sensor corrected ET based raster outputs completed successfully.

Checks (2 Checks) for precipitation raster outputs completed successfully.

Tests (2 Tests) for sensor corrected CSV outputs completed successfully.

All tests passed!