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.0rc1.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.

File details

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.0rc1.tar.gz
Algorithm Hash digest
SHA256 eb16ce7e2698fc850b5e016918920d0a869fbadff8e0acfc858b9a3dffdeb031
MD5 f1d93f0ec198160e99128f996ab65cdc
BLAKE2b-256 8abafb821d770c3e0da6fca0fb200ddf04868febea49ad39b1aa577e60d1942b

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 746f77e4062f6963963f0626457e10c2b8d73fd2020c17a78ac11150a9c06747
MD5 0319eec1b7f18847cf5ff8ade0aabea9
BLAKE2b-256 41150c7319cf1d65826e8338ae8099ddb484464b213de674f0e627b8595ebe6c

See more details on using hashes here.

Provenance

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