Metadata-Version: 2.1
Name: pyextremes
Version: 0.2.0
Summary: Extreme value analysis (EVA) in Python
Home-page: https://github.com/georgebv/pyextremes
Author: Georgii Bocharov
Author-email: bocharovgeorgii@gmail.com
License: GPLv3
Keywords: statistics extreme eva coastal ocean marine engineering
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)

.. role:: bash(code)
   :language: bash

.. role:: python(code)
   :language: python

|build status| |coverage status| |pypi package|

pyextremes
==========
**pyextremes** is a Python library dedicated to solving problems from the area of `Extreme Value Analysis (EVA) <https://en.wikipedia.org/wiki/Extreme_value_theory>`_. It provides tools to extract extreme events from time series using Block Maxima or Peaks Over Threshold methods, to fit models such as GEV and GPD to the extracted extreme values, and to provide estimates of extreme events and corresponding confidence intervals for given return periods. Models are fitted to the data using the Maximum Likelihood Estimate (MLE, via `scipy <https://www.scipy.org/>`_) or the Markov Chain Monte Calro (MCMC, via `emcee <https://emcee.readthedocs.io/en/stable/>`_) models.

**Version:** 0.2.0

**License:** GNU General Public License v3.0

**E-Mail:** bocharovgeorgii@gmail.com

**Documentation:** coming soon

Installation
============
.. code:: bash

    pip install pyextremes

Dependencies
============
**Python version:** >=3.7

**Required packages:** emcee matplotlib numpy pandas scipy

Tutorials
=========
- `Basic usage <https://nbviewer.jupyter.org/github/georgebv/pyextremes-notebooks/blob/master/notebooks/EVA%20basic.ipynb>`_
- Models
- Statistical distributions

Illustrations
=============
Extreme value extraction

|extreme events image|

Model diagnostic

|model diagnostic image|

.. |build status| image:: https://travis-ci.org/georgebv/pyextremes.svg?branch=master
   :target: https://travis-ci.org/georgebv/pyextremes

.. |coverage status| image:: https://codecov.io/gh/georgebv/pyextremes/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/georgebv/pyextremes

.. |pypi package| image:: https://badge.fury.io/py/pyextremes.svg
    :target: https://badge.fury.io/py/pyextremes

.. |extreme events image| image:: ./docs/source/example_images/extremes.png

.. |model diagnostic image| image:: ./docs/source/example_images/diagnostic.png


