ACTUNEO

User Guide

  • Installation
    • Requirements
    • Installing from PyPI
    • Installing from Source
    • Development Installation
    • Optional Dependencies
      • Machine Learning
      • Visualization
    • Verifying Installation
  • Quick Start Guide
    • Basic Usage
    • Mortality Tables
      • Creating a Mortality Table
      • Life Expectancy
      • Survival Probabilities
    • Financial Calculations
      • Interest Theory
      • Yield Curves
    • Life Insurance
      • Whole Life Assurance
      • Term Assurance
      • Endowment Assurance
    • Annuities
      • Life Annuities
      • Deferred Annuities
    • Next Steps
  • Examples
    • Example 1: Complete Mortality Analysis
    • Example 2: Pension Valuation
    • Example 3: Life Insurance Premium Calculation
    • Example 4: Yield Curve Analysis
    • Example 5: Reserve Calculation
    • More Examples
    • Contributing Examples

API Reference

  • Mortality Module
    • MortalityTable
      • MortalityTable.__init__()
      • MortalityTable.ex()
      • MortalityTable.from_csv()
      • MortalityTable.from_dataframe()
      • MortalityTable.from_zimbabwe_2023()
      • MortalityTable.get_px()
      • MortalityTable.get_qx()
      • MortalityTable.life_expectancy()
      • MortalityTable.npx()
      • MortalityTable.px()
      • MortalityTable.qx()
      • MortalityTable.to_dataframe()
    • SurvivalFunctions
      • SurvivalFunctions.__init__()
      • SurvivalFunctions.annuity_due()
      • SurvivalFunctions.annuity_immediate()
      • SurvivalFunctions.assurance()
      • SurvivalFunctions.net_single_premium()
      • SurvivalFunctions.npx()
      • SurvivalFunctions.nqx()
      • SurvivalFunctions.tpx()
    • MortalityTable
      • MortalityTable
        • MortalityTable.__init__()
        • MortalityTable.ex()
        • MortalityTable.from_csv()
        • MortalityTable.from_dataframe()
        • MortalityTable.from_zimbabwe_2023()
        • MortalityTable.get_px()
        • MortalityTable.get_qx()
        • MortalityTable.life_expectancy()
        • MortalityTable.npx()
        • MortalityTable.px()
        • MortalityTable.qx()
        • MortalityTable.to_dataframe()
    • SurvivalFunctions
      • SurvivalFunctions
        • SurvivalFunctions.__init__()
        • SurvivalFunctions.annuity_due()
        • SurvivalFunctions.annuity_immediate()
        • SurvivalFunctions.assurance()
        • SurvivalFunctions.net_single_premium()
        • SurvivalFunctions.npx()
        • SurvivalFunctions.nqx()
        • SurvivalFunctions.tpx()
  • Finance Module
    • DurationConvexity
      • DurationConvexity.__init__()
      • DurationConvexity.bond_convexity()
      • DurationConvexity.bond_duration()
      • DurationConvexity.convexity()
      • DurationConvexity.key_rate_duration()
      • DurationConvexity.macaulay_duration()
      • DurationConvexity.modified_duration()
      • DurationConvexity.portfolio_duration()
      • DurationConvexity.price_change_approximation()
    • InterestTheory
      • InterestTheory.__init__()
      • InterestTheory.annuity_future_value()
      • InterestTheory.annuity_present_value()
      • InterestTheory.effective_annual_rate()
      • InterestTheory.future_value()
      • InterestTheory.inflation_adjusted_value()
      • InterestTheory.loan_balance()
      • InterestTheory.loan_payment()
      • InterestTheory.nominal_rate()
      • InterestTheory.present_value()
      • InterestTheory.real_interest_rate()
    • YieldCurve
      • YieldCurve.__init__()
      • YieldCurve.bootstrap_spot_rates()
      • YieldCurve.from_par_rates()
      • YieldCurve.from_zero_rates()
      • YieldCurve.get_discount_factor()
      • YieldCurve.get_forward_rate()
      • YieldCurve.get_spot_rate()
      • YieldCurve.get_yield()
      • YieldCurve.plot_yield_curve()
    • InterestTheory
      • InterestTheory
        • InterestTheory.__init__()
        • InterestTheory.annuity_future_value()
        • InterestTheory.annuity_present_value()
        • InterestTheory.effective_annual_rate()
        • InterestTheory.future_value()
        • InterestTheory.inflation_adjusted_value()
        • InterestTheory.loan_balance()
        • InterestTheory.loan_payment()
        • InterestTheory.nominal_rate()
        • InterestTheory.present_value()
        • InterestTheory.real_interest_rate()
    • YieldCurve
      • YieldCurve
        • YieldCurve.__init__()
        • YieldCurve.bootstrap_spot_rates()
        • YieldCurve.from_par_rates()
        • YieldCurve.from_zero_rates()
        • YieldCurve.get_discount_factor()
        • YieldCurve.get_forward_rate()
        • YieldCurve.get_spot_rate()
        • YieldCurve.get_yield()
        • YieldCurve.plot_yield_curve()
    • DurationConvexity
      • DurationConvexity
        • DurationConvexity.__init__()
        • DurationConvexity.bond_convexity()
        • DurationConvexity.bond_duration()
        • DurationConvexity.convexity()
        • DurationConvexity.key_rate_duration()
        • DurationConvexity.macaulay_duration()
        • DurationConvexity.modified_duration()
        • DurationConvexity.portfolio_duration()
        • DurationConvexity.price_change_approximation()
  • Life Module
    • Annuities
      • Annuities.__init__()
      • Annuities.annuity_certain_with_life_contingency()
      • Annuities.annuity_due()
      • Annuities.annuity_with_withdrawal()
      • Annuities.contingent_annuity()
      • Annuities.decreasing_annuity()
      • Annuities.deferred_life_annuity()
      • Annuities.guaranteed_annuity()
      • Annuities.immediate_annuity()
      • Annuities.increasing_annuity()
      • Annuities.joint_life_annuity()
      • Annuities.life_annuity_due()
      • Annuities.life_annuity_immediate()
      • Annuities.temporary_life_annuity_due()
      • Annuities.temporary_life_annuity_immediate()
    • LifeAssurance
      • LifeAssurance.__init__()
      • LifeAssurance.annual_premium()
      • LifeAssurance.contingent_assurance()
      • LifeAssurance.deferred_assurance()
      • LifeAssurance.endowment_assurance()
      • LifeAssurance.gross_premium()
      • LifeAssurance.joint_life_assurance()
      • LifeAssurance.pure_endowment()
      • LifeAssurance.reserve_endowment()
      • LifeAssurance.reserve_term()
      • LifeAssurance.reserve_whole_life()
      • LifeAssurance.temporary_life_annuity()
      • LifeAssurance.term_assurance()
      • LifeAssurance.whole_life_annuity()
      • LifeAssurance.whole_life_assurance()
    • Reserves
      • Reserves.__init__()
      • Reserves.contingency_reserve()
      • Reserves.gross_reserve()
      • Reserves.net_level_premium_reserve()
      • Reserves.prospective_reserve_endowment()
      • Reserves.prospective_reserve_term()
      • Reserves.prospective_reserve_whole_life()
      • Reserves.reserve_distribution()
      • Reserves.reserve_release()
      • Reserves.retrospective_reserve_whole_life()
      • Reserves.terminal_reserve()
      • Reserves.zillmerized_reserve()
    • LifeAssurance
      • LifeAssurance
        • LifeAssurance.__init__()
        • LifeAssurance.annual_premium()
        • LifeAssurance.contingent_assurance()
        • LifeAssurance.deferred_assurance()
        • LifeAssurance.endowment_assurance()
        • LifeAssurance.gross_premium()
        • LifeAssurance.joint_life_assurance()
        • LifeAssurance.pure_endowment()
        • LifeAssurance.reserve_endowment()
        • LifeAssurance.reserve_term()
        • LifeAssurance.reserve_whole_life()
        • LifeAssurance.temporary_life_annuity()
        • LifeAssurance.term_assurance()
        • LifeAssurance.whole_life_annuity()
        • LifeAssurance.whole_life_assurance()
    • Annuities
      • Annuities
        • Annuities.__init__()
        • Annuities.annuity_certain_with_life_contingency()
        • Annuities.annuity_due()
        • Annuities.annuity_with_withdrawal()
        • Annuities.contingent_annuity()
        • Annuities.decreasing_annuity()
        • Annuities.deferred_life_annuity()
        • Annuities.guaranteed_annuity()
        • Annuities.immediate_annuity()
        • Annuities.increasing_annuity()
        • Annuities.joint_life_annuity()
        • Annuities.life_annuity_due()
        • Annuities.life_annuity_immediate()
        • Annuities.temporary_life_annuity_due()
        • Annuities.temporary_life_annuity_immediate()
    • Reserves
      • Reserves
        • Reserves.__init__()
        • Reserves.contingency_reserve()
        • Reserves.gross_reserve()
        • Reserves.net_level_premium_reserve()
        • Reserves.prospective_reserve_endowment()
        • Reserves.prospective_reserve_term()
        • Reserves.prospective_reserve_whole_life()
        • Reserves.reserve_distribution()
        • Reserves.reserve_release()
        • Reserves.retrospective_reserve_whole_life()
        • Reserves.terminal_reserve()
        • Reserves.zillmerized_reserve()
  • Pensions Module
    • Planned Features
  • IFRS 17 Module
    • Planned Features
  • Loss Reserving Module
    • Planned Features
  • Macro Africa Module
    • Planned Features
  • Simulation Module
    • Planned Features
  • Utils Module
    • Planned Features

Development

  • Contributing to ACTUNEO
    • Getting Started
    • Development Setup
    • Code Style
    • Running Tests
    • Writing Tests
    • Documentation
    • Areas for Contribution
      • African Mortality Tables
      • Regulatory Frameworks
      • Pension Systems
      • IFRS 17
      • Loss Reserving
      • Documentation
      • Testing
    • Pull Request Process
    • Community Guidelines
    • Contact
  • Changelog
    • Version 0.1.2 (2026-05-12)
      • Added
      • Changed
      • Fixed
    • Version 0.1.1 (2025-01-10)
      • Changed
      • Fixed
    • Version 0.1.0 (2025-01-10)
      • Added
      • Features
      • Modules
    • Upcoming
      • Version 0.2.0 (Planned)
      • Version 0.3.0 (Planned)
ACTUNEO
  • Search

© Copyright 2025, Shannon Tafadzwa Sikadi.

Built with Sphinx using a theme provided by Read the Docs.