About

1. Copyright and license
2. Citing pelicun
3. Logo
4. Acknowledgments
- 4.1. National Science Foundation
- 4.2. Contributors
5. Release Notes

User Guide

1. Getting started
- 1.1. Staying up to date
2. The Pelicun Framework
3. Overview of pelicun features
4. Damage and loss library
5. Bug reports and feature requests
6. Resources for new python users
7. Examples
8. API Reference
- 8.1. pelicun

Developer Guide

1. Getting started
- 1.1. Code of conduct
- 1.2. How to contribute
2. Setting up a development environment
3. Coding practice
4. Package architecture
- 4.1. Overview of files

pelicun

8. API Reference
8.1. pelicun
pelicun.tests
pelicun.tests.tools

pelicun.tests.tools

This module contains tests for the tools module of pelicun.

Modules

test_regional_sim

These are tests for the regional_sim module of pelicun.

© Copyright 2026, Leland Stanford Junior University and The Regents of the University of California.