SMADI

This is the documentation of SMADI.

Note

This is the main page of your project’s Sphinx documentation. It is formatted in reStructuredText. Add additional pages by creating rst-files in docs and adding them to the toctree below. Use then references in order to link them from this page, e.g. Contributors and Changelog.

It is also possible to refer to the documentation of other Python packages with the Python domain syntax. By default you can reference the documentation of Sphinx, Python, NumPy, SciPy, matplotlib, Pandas, Scikit-Learn. You can add more by extending the intersphinx_mapping in your Sphinx’s conf.py.

The pretty useful extension autodoc is activated by default and lets you include documentation from docstrings. Docstrings can be written in Google style (recommended!), NumPy style and classical style.

Contents

• Overview
  • Features
  • Case Studies
• Anomalies Indicators
  • Z-score: The Standardized Z-score
  • SMAD: Standardized Median Anomaly Deviation
  • Beta Distribution
  • Gamma Distribution
  • ESSMI: Empirical Standardized Soil Moisture Index
  • SMDS: Soil Moisture Drought Severity
  • SMCI: Soil Moisture Condition Index
  • SMCA: Soil Moisture Content Anomaly
  • SMAPI: Soil Moisture Anomaly Percentage Index
  • SMDI: Soil Moisture Deficit Index
• Installation
  • 1.1 Prerequisites
  • 1.2 Installing SMADI
  • 1.3 Verifying Installation
• Loading Data
• Compute Climatology
  • 3.1 Compute normals at various time steps
  • 3.2 Computing the normals using different metrics (median, max, ..etc)
  • 3.3 Filling the gaps and smoothing the time series data (optional)
  • 3.4 Computing the normals for a subset of the data
• Plot Climatology
  • 4.1 Loading the data
  • 4.2 Plot the time series data
• Detect Anomalies
  • 5.1 Loading the data
  • 5.2 Zscore Usage Example
  • 5.3 SMAPI Usage Example
  • 5.4 ParaDis Usage Example
  • 5.5 ESSMI Usage Example
• Run Workflow
  • 6.1 Positional Arguments
  • 6.2 Optional Arguments
  • 6.3 Workflow Syntax
• Contributions & Help
  • Issue Reports
  • Documentation Improvements
  • Code Contributions
  • Maintainer tasks
• License
• Authors
• Changelog
  • Version 1.0.0, 2024-04-23
• Module Reference
  • smadi package

Indices and tables

• Index

• Module Index

• Search Page