Welcome to the smodex’s documentation!

smodex

Soil moisture and soil moisture anomalies are critical markers of dryness and agricultural drought and is used by researchers, water resource managers and policy markers to understand dryness and wetness conditions including dry spells and the onset and offset drought in an area.

smodex is a tool that enhances the performant computation, visualization and sharing of soil moisture and soil moisture anomalies using climate datasets. It embraces the principles of FAIR and Open Science in the development of the computational workflow and the data sharing for quick and easy access within the scientific community.

Features

• Downloads climate datasets from Climate Data Store,

• Computation of climatological statistics at different rolling means and time-scale,

• Computes anomalies at different time-scales,

• Supports Python versions 3.7+

• Released under the MIT No Attribution license.

User guide

A step by step guide on getting started with smodex package

• Installation
  • Option 1: Use Pip (Recommended)
  • Option 2: Clone the repository
• Getting Started
  • 1. Data Loading
  • 2. Climatology computation
  • 3. Anomalies computation
  • 4. Data visualization
  • 5. Data sharing
• API Documentation
  • smodex package
• Contributing
  • Type of contributions
  • Getting started

Note

The smodex package is currently under development and the API documentation is being updated

smodex license

the smodex package is release under the MIT No-Attribution license.