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, 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 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.5.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.5-py3-none-any.whl (47.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.5.tar.gz
Algorithm Hash digest
SHA256 61b7ac6b90f0fa9a28e53e5465dbae0a90836cc98ac3ae3560ae1e7be3cfd9f1
MD5 19f6b2f4b1d1fa4720f97575ed7f6e10
BLAKE2b-256 d54a1005db557ea928782119bde78b8c563ec6e4d4be355b7e402ef33ffcfe8e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bdf800570f2c2a1eae2b96228c4d78eac5429e51e3e02f013a28c87868a342d3
MD5 95dc0c2b070c4cd487effbcf5f47672c
BLAKE2b-256 d3e7f88a1edefc18fd8f584566f558e61fc5a38e298251d880cb471b10957933

See more details on using hashes here.

Provenance

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