Welcome to Probextreme

This is a library to work with the Extreme Values Theory (EVT). The toolbox is designed to gather different approaches and tools to characterise extreme events and their significance based on data.

This library is under construction

Installation

git clone https://github.com/ArcticSnow/probextreme.git

# install in development mode
pip install -e probextreme

Documentation

# install necessary package for documentation
pip install mkdocs lazydocs sphinx_rtd_theme mkdocs-material pygments

Run documentation locally

cd github/probextreme
mkdocs serve

Update API documentation

cd github/probextreme
lazydocs --output-path="./docs/api" .

For further information on documentation tools: - mkdocs - lazydocs

Credits

S. Filhol, F. Doussot, - May 2024