lactuca 0.1.6

Professional life actuarial library for Python with compiled performance and international tables

Lactuca

Professional life actuarial library for Python — life insurance, pensions, and disability: mortality and disability tables, annuities, insurances, commutation functions, and interest-rate scenarios, optimized for Spanish and international actuarial practice.

Installation

pip install lactuca

Requires Python ≥ 3.12. Runs on Windows, Linux, and macOS (wheels for CPython 3.12–3.14). Core runtime dependencies include NumPy, SciPy, Pandas, Polars, msgpack, PyNaCl, requests, and platformdirs (see pyproject.toml for pinned ranges).

Bundled tables (one-time setup)

Table data ships inside the package but must be written to disk as .ltk files before use. Run this once per environment (or after upgrading Lactuca):

from lactuca.tables.data import Tables

Tables.install()  # all bundled tables → ./actuarial_tables/ by default

Install only what you need: Tables.install("PER2020_Ind_1o"). The default directory is actuarial_tables/ under your current working directory; change it with lactuca.config.tables_path. See the Bundled Tables guide for the full catalogue.

Activation

Proprietary software — a valid license key is required before calculations run.

On the first use (python -m lactuca or import lactuca), the library looks for a license in this order:

1. LACTUCA_LICENSE_KEY environment variable (recommended for servers and CI/CD).
2. Local license.json in your Lactuca config directory (offline use after first activation).
3. Interactive prompt — enter an existing key or request a free 30-day trial.

# Interactive activation (same as omitting the subcommand)
python -m lactuca
python -m lactuca activate

# License maintenance (script-friendly)
python -m lactuca license status [--json]
python -m lactuca license refresh [--json]
python -m lactuca license doctor [--json]

• 🆓 Free trial: www.lactuca.io/pricing
• 💼 Buy a license: www.lactuca.io/pricing
• 📄 License terms: End User License Agreement · LICENSE summary
• 📖 Full activation guide: Activation Guide

Check the version

python -c "import lactuca; print(lactuca.__version__)"

The first import runs activation (see above). To read pip metadata without importing the package:

pip show lactuca
python -c "from importlib.metadata import version; print(version('lactuca'))"

Quick Start

Requires an activated license — see Activation above (LACTUCA_LICENSE_KEY, license.json, or the interactive trial).

Requires bundled tables on disk — run Tables.install() once (see Bundled tables).

Lactuca centres on three table classes — LifeTable (mortality), DisabilityTable (disability incidence), and ExitTable (withdrawals) — plus InterestRate, GrowthRate, and a global Config for calculation defaults. Generational tables require a cohort birth year; select-ultimate tables require a duration (select year, or "ult" for ultimate); some tables need both.

from lactuca import LifeTable, äx

# Static PASEM 2020 general table, 2nd order (Spanish best-estimate mortality)
lt = LifeTable("PASEM2020_Gen_2o", "m")

# Generational individual table with explicit cohort (PER 2020, male, born 1969)
lt_cohort = LifeTable("PER2020_Ind_1o", "m", cohort=1969)

# Select-ultimate table (UK AM92/AF92, male) — duration picks the select slice
# (AM92/AF92 uses Duration-0: first select year is duration=0)
lt_select = LifeTable("AM92_AF92", "m", duration=0)

# 15-year temporary life annuity-due, annual payments (m=1), 3% interest
# n = term in years, m = payment frequency per year (1=annual, 12=monthly)
annuity = lt.äx(x=50, n=15, m=1, ir=0.03)
print(f"Life annuity value: {annuity:.4f}")

# Identical result via the functional API:
annuity = äx(table=lt, x=50, n=15, m=1, ir=0.03)
print(f"Life annuity value: {annuity:.4f}")

Features

• ✅ International actuarial tables — bundled and ready to install (see catalogue):
  • Spain (DGSFP): PASEM2010; PASEM2020 (Gen, Dec, Rel, NoRel, 1st/2nd order); PER2020 (Col/Ind, 1st/2nd); PEAI2007 (IAP Ind/Col)
  • Spain (SS): IASS90; SS90TOT; SS90ABS
  • Germany (DAV): DAV2004R aggregate and select-ultimate (1st/2nd order)
  • USA (SOA): GAM71, GAM83, GAM94_AA
  • UK (CMIB): AM92_AF92 (select-ultimate, Duration-0)
  • Switzerland (SOA): GRMF80, GRMF95, GKMF80, GKMF95
  • Chile (CMF NCG 305/2023): CB_H_2020, MI_H_2020, MI_M_2020, RV_M_2020, B_M_2020
• ✅ Generational mortality with exponential, linear, and discrete improvement factors (cohort); select-ultimate tables with duration-dependent rates (duration or "ult")
• ✅ LifeTable, DisabilityTable, and ExitTable — mortality, disability incidence, and exit/withdrawal decrements (including multiple-decrement combinations)
• ✅ Custom tables — build proprietary .ltk tables with TableBuilder or load them via read_table
• ✅ Annuities (discrete/continuous, immediate/due, fractional frequencies)
• ✅ Life insurances (term, whole life, endowment)
• ✅ Commutation functions (Dx, Nx, Cx, Mx, Rx, Sx, Lx, Tx, ex and joint-life variants)
• ✅ Functional API (scalar and vectorized: ax, äx, Ax, tpx, ex, nEx; multi-life annuities axy/äxy (2), axyz/äxyz (3), ajoint/äjoint (N); pure endowments nExy/nExyz/nEjoint; first-death insurances Axy, Axyz, Afirst…)
• ✅ Batch API — vectorized multi-policy calculations with scalar equivalence when N=1; Pandas and Polars Series supported on batch inputs
• ✅ Flexible interest rates with InterestRate (flat rate, piecewise term structure, named scenarios)
• ✅ Growth rate scenarios with GrowthRate for benefit escalation
• ✅ Global Config — calculation modes (discrete_precision, continuous_precision, …), mortality placement, and interpolation defaults
• ✅ Fractional time shifts (ts) with UDD/CFM interpolation methods
• ✅ Actuarial date utilities (exact age, last/nearest/next birthday, anniversary dates)
• ✅ Highly optimized with NumPy vectorization and Cython compilation
• ✅ Type-safe with full type hint coverage and stub files (.pyi)

Documentation

📚 Full Documentation

• Getting Started Guide
• Bundled Tables
• Activation Guide
• API Reference
• Actuarial Formulas
• Changelog

Documentation is licensed under CC BY 4.0. The library code and binaries remain proprietary — see the EULA and LICENSE.

Contact

📧 [e-mail]
🌐 https://www.lactuca.io

---

_{Built with ❤️ for the actuarial community using Cython for maximum performance.}