Skip to main content

Agriculture and Agri-Food Canada (AAFC)

Project description

# Real‐Time In‐Situ Soil Monitoring for Agriculture (RISMA) network

## Overview

The Real-time In-Situ Soil Monitoring for Agriculture (RISMA) network provides accurate, near real-time soil and weather data from various agricultural regions across Canada. Established in 2010, RISMA is a collaborative effort between Agriculture and Agri-Food Canada (AAFC) and its partners, including Environment Canada, the Global Institute for Water Security (University of Saskatchewan), and the University of Guelph.

The network captures a wide range of data points every 15 minutes, including: * Soil Conditions: Soil moisture and temperature at multiple depths (0-5cm, 5cm, 20cm, 50cm, 100cm, and 150cm). * Meteorological Data: Precipitation, air temperature, relative humidity, wind speed, and wind direction.

As of 2015, the network consists of 22 stations located in Manitoba, Saskatchewan, and Ontario. The data from these stations is crucial for applications such as flood and yield forecasting, as well as for validating satellite-based environmental products.

Please see our quick user guide for more information on how to use this Portal by [clicking here](https://agrifood.aquaticinformatics.net/AQWebPortal/Data/GetFile/GettingStartedGuide)

## Getting Started

To get started with RISMA, follow the steps below.

### Prerequisites

  • Python 3.8 or higher

  • Jupyter Notebook or JupyterLab

  • Git

### Installation

  1. Clone the repository:

    `bash git clone https://github.com/morteza-khazaei/RISMA.git cd RISMA `

  2. Create a virtual environment (recommended):

    `bash python -m venv venv source venv/bin/activate # On Windows: `venv\Scripts\activate` `

  3. Install RISMA:

    `bash pip install . `

### Running the Tutorial

The tutorial.ipynb notebook provides a comprehensive guide to using RISMA. To run it:

  1. Start Jupyter:

    `bash jupyter notebook `

  2. Open the `tutorial.ipynb` notebook:

## Usage

### Command-Line Interface (CLI)

The RISMA package includes a powerful command-line interface (CLI) for interacting with the data portal. It can be run as a step-by-step interactive session or by executing individual commands.

To start the interactive session, simply run:

`bash risma `

This will launch a stateful session that guides you through the data selection and download process. Inside the session, you can run commands like params –list-only, status, or exit.

Alternatively, you can run each command directly from your shell by prefixing it with risma, for example: risma params –list-only.

Global Options:

  • –server: Specify the Aquarius server URL (defaults to agrifood.aquaticinformatics.net).

  • –verbose or -v: Enable detailed output.

You can get help on any command or subcommand by using the -h or –help flag:

`bash risma --help risma params --help `

#### Step-by-Step Workflow

The CLI is designed around a 4-step workflow.

1. Parameters Step (`params`)

Load and select the parameters you are interested in (e.g., “Air Temp”, “Soil Moisture”).

  • Load: params –list-only - Shows all available parameters

  • Select: params –select “Air Temp” “Soil Moisture” - Select specific parameters

  • Interactive: params - Shows parameters with current selections marked

2. Stations Step (`stations`)

Load and select the monitoring stations.

  • Load: stations –list-only - Shows all available stations

  • Select: stations –select RISMA_MB1 RISMA_MB2 - Select specific stations

  • Interactive: stations - Shows stations with current selections marked

3. Datasets Step (`datasets`)

Find available datasets based on your selected parameters and stations. You can further filter by sensor and depth.

  • Load: datasets –list-only - Shows available datasets based on selections

  • Filter: datasets –sensors average –depths “0 to 5 cm” - Add filters

  • Interactive: datasets - Shows datasets ready for download

4. Download Step (`download`)

Download the time-series data for the selected datasets.

  • Execute: download –start-date 2024-01-01 –end-date 2024-01-31

  • Default: download - Downloads last 7 days

#### Utility Commands

The following commands are also available (primarily for interactive mode):

`bash status # Show your current selections (parameters, stations, etc.). reset # Clear all your selections and start over. help # Display help information. exit # Exit the interactive session. `

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

risma-2025.7.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

risma-2025.7-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file risma-2025.7.tar.gz.

File metadata

  • Download URL: risma-2025.7.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for risma-2025.7.tar.gz
Algorithm Hash digest
SHA256 3d943daff19de37de8d6af211dab47e8f788ea51b674f6ec1b125c88733c6fbd
MD5 7e9a277c01d55c7df59a976d6d3ffc8a
BLAKE2b-256 109316560d391bf1f6cc4bd341619c28d95b573928a2f1415482ac048db8b72a

See more details on using hashes here.

File details

Details for the file risma-2025.7-py3-none-any.whl.

File metadata

  • Download URL: risma-2025.7-py3-none-any.whl
  • Upload date:
  • Size: 22.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for risma-2025.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2c583d81d7587805b372a0db8629ff20605afb22b0237f771b3ddd336bde3c20
MD5 8ee021776eac4fba6697e949f53b4dfd
BLAKE2b-256 88c5c846e550233bacbcc75783e083881244bd34afa6c1764e01be82196e9eec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page