Skip to main content
https://github.com/TUW-GEO/pytesmo/workflows/Automated%20Tests/badge.svg?branch=master ReadTheDocs PyPI-Server Binder Project generated with PyScaffold

SMADI

Soil Moisture Anomaly Detection Indicators

This repository contributes to a visiting research activity within the framework of EUMETSAT HSAF, hosted by TU Wien, on the subject “development of workflows for climate normal and anomaly calculation for satellite soil moisture products”.

SMADI is a comprehensive workflow designed to compute climate normals and detect anomalies in satellite soil moisture data. The primary focus is on ASCAT surface soil moisture (SSM) products. By establishing the distribution of SSM for each period and location, SMADI computes climatology, or climate normals, and subsequently identifies anomalies.

The core objective of SMADI is to leverage these anomaly indicators to identify and highlight extreme events such as droughts and floods, providing valuable insights for environmental monitoring and management. Furthermore, the methods used apply to other meteorological variables, such as precipitation, temperature, and more.

Features

  • Data Reading: Read and preprocess the input data from Supported data sources.

  • Climatology: Compute the climatology for the input data based on different time steps (e.g., monthly, dekadal, weekly, etc.).

  • Anomaly Detection: Detect anomalies based on the computed climatology using different anomaly detection indices.

  • Visualization: Visualize the computed climatology and anomalies as time series, maps, and histograms.

Workflow Processing

The package installation through pip will enable a command-line entry point for calculating anomalies using one or more of the available methods across various dates. The command, named ‘smadi_run’, is designed to compute indices for the ASCAT gridded NetCDF datasets. This Python entry point is intended to be executed through a bash shell command:

smadi_run <positional arguments> <options>

For more information about the positional and optional arguments of this command, run:

smadi_run -h

Installation

User Installation

For users who simply want to use smadi, you can install it via pip:

pip install smadi

Developer Installation

If you’re a developer or contributor, follow these steps to set up smadi:

  1. Clone the repository:

git clone https://github.com/MuhammedM294/smadi
  1. Navigate to the cloned directory:

cd smadi
  1. Create and activate a virtual environment using Conda or virtualenv:

For Conda:

conda create --name smadi_env python=3.8
conda activate smadi_env

For virtualenv:

virtualenv smadi_env
source smadi_env/bin/activate  # On Unix or MacOS
.\smadi_env\Scripts\activate    # On Windows
  1. Install dependencies from requirements.txt:

pip install -r requirements.txt

Docker Usage

To use the Docker image for SMADI, follow these steps:

  1. Pull the Docker Image:

    Open your terminal and run the following command to pull the Docker image from Docker Hub:

    docker pull muhammedabdelaal/smadi:latest
  2. Run the Docker Image:

    After pulling the image, you can run it with the following command:

    docker run -it muhammedabdelaal/smadi:latest

    This will start a container with the SMADI application.

Note

This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.

Metadata

Release files for smadi 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for smadi 1.1.1
File Size Uploaded Provenance Actions
smadi-1.1.1.tar.gz 159.9 kB Without provenance Details for smadi-1.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for smadi 1.1.1
File Interpreter ABI Platform Actions
smadi-1.1.1-py3-none-any.whl Python 3 none any Details for smadi-1.1.1-py3-none-any.whl

Total release size: 187.8 kB

Release files / smadi-1.1.1.tar.gz

Download URL smadi-1.1.1.tar.gz
Size 159.9 kB
Tags Source
SHA-256 checksum
How to use checksums
083a874300321dcbdb127f7e39ceb7f321295e7aab1dddf500f821cba1e101b6
BLAKE2b-256 checksum
How to use checksums
f216c4ce9cb1981cd7655e93f2625bd423b198c800c6d06c83d11f6c64b73517
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Release files / smadi-1.1.1-py3-none-any.whl

Download URL smadi-1.1.1-py3-none-any.whl
Size 27.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cc988600838ebfad03af01f8fa6ef775d46031b1b435bf189a1c712e9c954664
BLAKE2b-256 checksum
How to use checksums
e05d5efcf548c39d06791b4654a3a4f1c6cfa06c34b15a7a66874f99187fe72f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Security for smadi 1.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page