:notoc:

=======================
 Pelicun Documentation
=======================

.. warning::

   Development Preview Only.
   This documentation is intended for internal review and demonstration purposes.
   It is not finalized or ready for public use.

Pelicun is an open-source Python package for the probabilistic estimation of losses, injuries, and community resilience under natural disasters.
Community-driven, easy to use and extend, it serves as an integrated multi-hazard risk estimation framework for buildings and other infrastructure.
Utilized in both academia and industry, it supports cutting-edge natural hazards engineering research while helping spread the adoption of performance-based engineering in practical applications.

.. toctree::
   :caption: About
   :maxdepth: 1
   :numbered: 2

   about/license.rst
   about/cite.rst
   about/acknowledgments.rst
   release_notes/index.rst

.. toctree::
   :caption: User Guide
   :maxdepth: 1
   :numbered: 2

   user_guide/install.rst
   user_guide/pelicun_framework.rst
   user_guide/feature_overview.rst
   user_guide/damage_and_loss_library.rst
   user_guide/bug_reports_and_feature_requests.rst
   user_guide/resources_for_new_python_users.rst
   examples/index.rst
   api_reference/index.rst

.. toctree::
   :caption: Developer Guide
   :maxdepth: 1
   :numbered: 2

   developer_guide/getting_started.rst
   developer_guide/development_environment.rst
   developer_guide/code_quality.rst
   developer_guide/internals.rst