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

Documentation Status


An actuarial stochastic modeling library in python.

Note This library is still in beta!

📚 Development Guide - Get started with development setup and testing

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, n=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

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.10.tar.gz (5.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.10-py3-none-any.whl (57.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.10.tar.gz
Algorithm Hash digest
SHA256 ec3f9bf3c96f75f2b74f099b5a944ccc291863ef7b0f92581e2fbc39a18a0960
MD5 6628a6aed42ea45f3fd7dc3095728a0d
BLAKE2b-256 d441e79eee87db550240f59299c18ddf89682c6545a08e9767b3dbd95ac262d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for proteusllp_actuarial_library-0.2.10.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.10-py3-none-any.whl.

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 daef90a118d9b0a0816741adb46cb2231286ea010bd73fd880006755bde2ead7
MD5 f1cc29808dbfd00ab530fb8a7c96f3a4
BLAKE2b-256 1dc0fd7eb32f7a9e72a876b6c89fbcfc4ed9d5e58ff4beda1a71020f89a28602

See more details on using hashes here.

Provenance

The following attestation bundles were made for proteusllp_actuarial_library-0.2.10-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