Skip to main content

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

Project description

Proteus Actuarial Library

An actuarial stochastic modeling library in python.

Note This library is still in development!

📚 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

  • 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 a proof of concept. 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 in github

Contributing

You are welcome to contribute pull requests

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.1.0.tar.gz (29.1 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.1.0-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.1.0.tar.gz
Algorithm Hash digest
SHA256 192958821db06d950ea7fff28912e81ac0e37ca3c7a0beb37e0fe8ea1f20292f
MD5 818eead990487688b5d0cd984c434ceb
BLAKE2b-256 3065b03c6d6ff6cbfd2dac73369edee0483a9d55160bd30031634a444343b7c2

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for proteusllp_actuarial_library-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17ed185ae4e019299d2b5338493cd5c8ecb90d60819a9742d71f462208df0297
MD5 f815c79ff46c5e98250a3116ae272c50
BLAKE2b-256 07046cd67dda692e148934155aa46fe18c6d777bb4329abd07838e5819519087

See more details on using hashes here.

Provenance

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