Skip to main content

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

To get the latest stable version install using:

pip install spei

To get the development version download the GitHub code to your computer. Use cd to get to the download directory 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

Release files for spei 0.1.3

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

Source distribution (sdist)

Source distribution for spei 0.1.3
File Size Uploaded
spei-0.1.3.tar.gz 6.0 kB Details

Built distribution (wheel)

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

Total release size: 12.7 kB

Release files / spei-0.1.3.tar.gz

Download URL spei-0.1.3.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
829c226920e2ff85c46a8562464b0eb6be4851fe11f8abb1aab303b0f4ae706c
BLAKE2b-256 checksum
How to use checksums
d0a39cfcf79f2606557d897402db48487afa16b3045cf6a69ce8f5d8fb9d4e36
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.5

Release files / spei-0.1.3-py3-none-any.whl

Download URL spei-0.1.3-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f6f337d685685d0af27f2f33e162a2e6624a45d149d715c5bfaa4cf1a0e3dc42
BLAKE2b-256 checksum
How to use checksums
65fdaf8df6b218497e22d6669e8914e81fc102f2779d793a9e3d3f77cd0fec3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.5

Release history Release notifications | RSS feed

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.4

2 release files

This release

0.1.3 This release

2 release files

0.1.0

2 release files

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