Skip to main content

A simple Python package to calculate drought indices for time series such as the SPI, SPEI and SGI.

Project description

SPEI

A simple Python package to calculate drought indices for time series such as the SPI (Standardized Precipitation Index), SPEI (Standardized Precipitation Evaporation Index) and SGI (Standardized Groundwater Index). There are other great packages available to calculate these indices However, they are either written in R such as SPEI or don't have the Standardized Groundwater Index such as climate_indices. Additionaly, these packages provide ways to analyse spatial data but it is easier to only deal with time series. Therefore, this package uses the popular Python packages such as Pandas and Scipy to make it easy but versitile for the user to calculate the drought indices. With the use of Scipy all distributions available in the library can be used to fit the data. However, there are general recommendations for distributions when calculating the SPEI, SPI an SGI.

Note that this package does not calculate potential evaporation, we refer to pyet for that. All time series have to be calculated in advance and be provided as a pandas Series.

Installation

Download the GitHub code to your computer and install using pip install -e .

To Do

  • Setup package in nice way

  • Check SGI for other distributions

  • Check distribution correction for x = 0

  • Add way to identify best distribution on time series (with Scipy, Fitter or distfit)

  • Add examples

  • Add docstring

  • Add Visualisation with Matplotlib

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

spei-0.1.0.tar.gz (6.1 kB view hashes)

Uploaded Source

Built Distribution

spei-0.1.0-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

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