Skip to main content

Proteus Actuarial Library: A package for building and running stochastic actuarial models in Python.

Project description

PAL Logo

Proteus Actuarial Library

CI Status Coverage Status Documentation Status PyPI version Python versions CodeFactor Ruff


An actuarial stochastic modeling library in python.

Note This library is still in beta!

Introduction

The Proteus Actuarial Library (PAL) is a fast, lightweight framework for building simulation-based actuarial and financial models. It handles complex statistical dependencies using copulas while providing simple, intuitive syntax.

Key Features:

  • Built on NumPy/SciPy for performance
  • Optional GPU acceleration with CuPy
  • Automatic dependency tracking between variables
  • Comprehensive statistical distributions
  • Clean, Pythonic API

Quick Start

from pal import distributions, copulas

# Create stochastic variables
losses = distributions.Gamma(alpha=2.5, theta=2).generate()
expenses = distributions.LogNormal(mu=1, sigma=0.5).generate()

# Apply statistical dependencies
copulas.GumbelCopula(theta=1.2).apply([losses, expenses])

# Variables are now correlated
total = losses + expenses

Installation

# Basic installation
pip install proteusllp-actuarial-library

# With GPU support
pip install proteusllp-actuarial-library[gpu]

Documentation

Read the full documentation on Read the Docs

  • Usage Guide - Comprehensive examples and API documentation
  • Development Guide - Setting up the development environment and running tests
  • Examples - Example scripts showing how to use the library

Project Status

PAL is currently in early release preview (beta). There are a limited number of supported distributions and reinsurance contracts. We are working on:

  • Adding more distributions and loss generation types
  • Making it easier to work with multi-dimensional variables
  • Adding support for Catastrophe loss generation
  • Adding support for more reinsurance contract types (Surplus, Stop Loss etc)
  • Stratified sampling and Quasi-Monte Carlo methods
  • Reporting dashboards

Issues

Please log issues on our github page.

Contributing

You are welcome to contribute pull requests. Please see the Contributer License Agreement

📚 Development Guide - Get started with development setup and testing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proteusllp_actuarial_library-0.2.11.tar.gz (6.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

proteusllp_actuarial_library-0.2.11-py3-none-any.whl (74.0 kB view details)

Uploaded Python 3

File details

Details for the file proteusllp_actuarial_library-0.2.11.tar.gz.

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.11.tar.gz
Algorithm Hash digest
SHA256 edc92a80d4aecb343de0dffc44dbd54cb2218d62b96dec42bd20f1362e04a545
MD5 6bfcc6b328b80b328419f0fb8bc998c2
BLAKE2b-256 977d4a9bbd26968e0e94aee8b5a43dbdc662de315bbecd1d7b7cf0bbed4cbf17

See more details on using hashes here.

Provenance

The following attestation bundles were made for proteusllp_actuarial_library-0.2.11.tar.gz:

Publisher: ci.yml on ProteusLLP/proteusllp-actuarial-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file proteusllp_actuarial_library-0.2.11-py3-none-any.whl.

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 a123a9dbfcfb7108dc57de9d85ddc902dfc87200e9dd64236641d7ebabc5b377
MD5 1f3c4bf9528864e142c2a04f14d94d28
BLAKE2b-256 56d7ec23c7b631e295e69e6293fbbef79da255a932bffae45a6aeb558b51e1b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for proteusllp_actuarial_library-0.2.11-py3-none-any.whl:

Publisher: ci.yml on ProteusLLP/proteusllp-actuarial-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page