Welcome to the pelicun user guide. Below, you will find instructions on installing pelicun and information about the supported features, the basic concepts behind them, the terminology used, the expected inputs, and where to get help. Join our growing community of users and developers dedicated to advancing risk estimation practices and sharing insights.

1. Getting started

Pelicun is available on the Python Package Index (PyPI) and should work out-of-the-box in all major platforms.

Tip

We recommend installing the package under a virtual environment to avoid dependency conflicts with other packages. See also conda and mamba, two widely used programs featuring environment management.

Install command:

python -m pip install pelicun

1.1. Staying up to date

When a new version is released, you can use pip to upgrade:

python -m pip install --upgrade pelicun