Skip to main content

A comprehensive Python package for drought analysis, with standardized indices (SPI, SPEI, SSFI) and copula-based bivariate MSDI for multivariate drought characterization.

Project description

PyDRGHT

PyPI Python License Downloads Code size

A comprehensive Python package for drought analysis, with standardized indices (SPI, SPEI, SSFI) and copula-based bivariate MSDI for multivariate drought characterization.

PyDRGHT provides tools for univariate and multivariate drought assessment, combining standardized indices, classical indices, copula-based methods, and frequency analysis.


Features

  • Standardized indices (based on SPI methodology with different variables):

    • SPI (Standardized Precipitation Index)
    • SPEI (Standardized Precipitation Evapotranspiration Index)
    • SSFI (Standardized Streamflow Index)
    • SGI (Standardized Groundwater Index)
    • SSMI (Standardized Soil Moisture Index)
  • Classical drought indices:

    • RDI (Reconnaissance Drought Index)
    • RAI (Rainfall Anomaly Index)
    • PNI (Percent of Normal Index)
    • CZI (China-Z Index)
    • DI (Deciles Index)
  • Multivariate drought indices:

    • MSDI (Multivariate Standardized Drought Index) – both empirical and copula-based approaches
  • Drought characteristics:

    • Duration, severity, intensity, frequency
    • Start and end of drought events
    • Interarrival times between droughts
  • Frequency analysis:

    • Univariate frequency analysis
    • Copula-based BFA (Bivariate Frequency Analysis)
  • Additional tools:

    • Potential Evapotranspiration (PET) via Hargreaves and Thornthwaite methods
    • Dependence modeling with copulas (Archimedean, Elliptical, Extreme-value families)

Installation

pip install pydrght

Or from source:

git clone https://github.com/terzitb/pydrght.git
cd pydrght
pip install -e .

Quickstart

import pandas as pd
from pydrght import SI
from scipy.stats import gamma

# Load example precipitation data
data = pd.read_csv("data.csv", index_col=0, parse_dates=True)

# 12-month SPI (parametric, 3-p Gamma distribution)
spi = SI(data["PRECIPITATION"], ts=12)
spi_param = spi.fit_parametric(gamma, is_2p=False)

print(spi_param.head())

Package Structure

Module / Subpackage Description
pydrght.BFA Bivariate Frequency Analysis for drought severity & duration modeling
pydrght.CZI China-Z Index (CZI)
pydrght.DChar Drought Characteristics (duration, severity, frequency, etc.)
pydrght.DI Deciles Index (DI)
pydrght.Dist Distribution fitting
pydrght.MSDI Multivariate Standardized Drought Index (MSDI)
pydrght.PNI Percent of Normal Index (PNI)
pydrght.RAI Rainfall Anomaly Index (RAI)
pydrght.RDI Reconnaissance Drought Index (RDI)
pydrght.SI Standardized Index class for SPI, SPEI, SSFI, SGI, SSMI
pydrght.copulas Copula classes: ClaytonCopula, FrankCopula, GumbelCopula, GaussianCopula, GalambosCopula, PlackettCopula
pydrght.pet Potential Evapotranspiration (PET) methods: hargreaves, thornthwaite
pydrght.utils Utility functions: uni_emp, multi_emp, accu
pydrght/examples Example datasets (.csv) and usage notebooks (.ipynb)

Examples & Data

Check the examples/ folder for:

  • Sample datasets (data.csv, spi.csv, dchar.csv)
  • Jupyter notebooks (example_SI.ipynb, example_MSDI.ipynb, etc.)

References

  • McKee, T. B., Doesken, N. J., & Kleist, J. (1993). The relationship of drought frequency and duration to time scales. Proceedings of the 8th Conference on Applied Climatology, 179–184.

  • Vicente-Serrano, S. M., Beguería, S., & López-Moreno, J. I. (2010). A multiscalar drought index sensitive to global warming: The Standardized Precipitation Evapotranspiration Index. Journal of Climate, 23(7), 1696–1718. DOI: 10.1175/2009JCLI2909.1

  • Shukla, S., & Wood, A. W. (2008). Use of a standardized runoff index for characterizing hydrologic drought. Geophysical Research Letters, 35(2), L02405. DOI: 10.1029/2007GL032487

  • Sklar, A. (1959). Fonctions de répartition à n dimensions et leurs marges. Publications de l'Institut de Statistique de l'Université de Paris, 8, 229–231. DOI: 10.2139/ssrn.4198458

  • Gibbs, W. J., & Maher, J. V. (1967). Rainfall deciles as drought indicators. Bureau of Meteorology, Australia.

  • Hayes, M. J. (1999). Drought Indices. National Drought Mitigation Center, University of Nebraska-Lincoln.

  • van Rooy, M. P. (1965). A rainfall anomaly index (RAI) independent of time and space. Notos, 14, 43–48.

  • Hänsel, S., Schucknecht, A., & Matschullat, J. (2016). The Modified Rainfall Anomaly Index (mRAI)—is this an alternative to the Standardised Precipitation Index (SPI) in evaluating future extreme precipitation characteristics? Theoretical and Applied Climatology, 123, 827–844. DOI: 10.1007/s00704-015-1389-y

  • Tsakiris, G., & Vangelis, H. (2005). Establishing a drought index incorporating evapotranspiration. European Water, 9/10, 3–11.

  • Hayes, M., Svoboda, M., Wall, N., & Widhalm, M. (2011). The Lincoln Declaration on Drought Indices: Universal Meteorological Drought Index Recommended. Bulletin of the American Meteorological Society, 92(4), 485–488. DOI: 10.1175/2010BAMS3103.1

  • Farahmand, A., & AghaKouchak, A. (2015). A generalized framework for deriving nonparametric standardized drought indicators. Advances in Water Resources, 76, 140–145. DOI: 10.1016/j.advwatres.2014.11.012

  • Hao, Z., & AghaKouchak, A. (2013). Multivariate standardized drought index: a parametric multi-index model. Advances in Water Resources, 57, 12–18. DOI: 10.1016/j.advwatres.2013.03.009

  • Hao, Z., & AghaKouchak, A. (2014). A nonparametric multivariate multi-index drought monitoring framework. Journal of Hydrometeorology, 15(1), 89–101. DOI: 10.1175/jhm-d-12-0160.1

  • Wu, H., Hayes, M. J., Weiss, A., & Hu, Q. (2001). An evaluation of the Standardized Precipitation Index, the China-Z Index and the statistical Z-Score. International Journal of Climatology, 21(6), 745–758. DOI: 10.1002/joc.658


License

PyDRGHT is licensed under the MIT License – see the LICENSE file for details. Please cite the package if you use it in your work.


Citation

If you use PyDRGHT in your research, please cite the following article:

Terzi TB (2025) PyDRGHT: A comprehensive python package for drought analysis. Environmental Modelling & Software.


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

pydrght-0.1.1.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydrght-0.1.1-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

Details for the file pydrght-0.1.1.tar.gz.

File metadata

  • Download URL: pydrght-0.1.1.tar.gz
  • Upload date:
  • Size: 36.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for pydrght-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f9f1bbbb4f5c143255615fae698e0568d28344cde75fb72a18a5d5d425216972
MD5 cba8ed017b8dcb19299b1d985db51923
BLAKE2b-256 a79b08237490d1289ac5816b07a035a35b2c29fbcbaec0b76445b2ebbfe6af66

See more details on using hashes here.

File details

Details for the file pydrght-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pydrght-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 34.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for pydrght-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4b9ff8e40b75d656fe1480d4d05c51e4faf565b7f574662e247d49964cc01326
MD5 160341492d8522cb7f3244cdfbff658f
BLAKE2b-256 8efafff9a34b6442fd953afc43d554b444a7d352e6a4ca175063f79721abf984

See more details on using hashes here.

Supported by

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