Skip to main content

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

Project description

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, beta=2).generate()
expenses = distributions.LogNormal(mu=1, sigma=0.5).generate()

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

# Variables are now correlated
total = losses + expenses

Installation

# Basic installation
pip install proteus-actuarial-library

# With GPU support
pip install proteus-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.0.tar.gz (54.2 kB 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.0-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3bd85fcb6df4ea82ac7b5aa48ba393f9e16c912b3ed9d3fc884598f5dc08fc92
MD5 66381c9aa4f2000c7bb565f6928cec30
BLAKE2b-256 8eed0b8292f2df0d63dc7ccf5485e00ae811d95f0866c1c612ca55581b1c7999

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83ce134cd4d9124f03a0b5c80942feb8213b94cbaf8d1165891896f9a3deefba
MD5 98ff52414d7b60274fd04f73bd8d9430
BLAKE2b-256 6060457d11035213ba97e3552eb497a9bed3daaa0018b7dbf932b9af8d1993c4

See more details on using hashes here.

Provenance

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