Skip to main content

Framework for actuarial cash flow models

Project description

PyPI Latest Release pytest Documentation Status

Info

Cashflower is an open-source Python framework for actuarial cash flow models.

Prerequisites

Python version >=3.9

Usage

Installation

terminal

pip install cashflower

Create model

python console

from cashflower import create_model

create_model("my_model")

Creates:

my_model/
    input.py
    model.py
    run.py
    settings.py

Input

my_model/input.py

runplan = Runplan(data=pd.DataFrame({"version": [1]}))

main = ModelPointSet(data=pd.DataFrame({"id": [1]}))

Model

my_model/model.py

@variable()
def projection_year(t):
    if t == 0:
        return 0
    elif t % 12 == 1:
        return projection_year(t - 1) + 1
    else:
        return projection_year(t - 1)

Calculate

terminal

python run.py

Contribution

The cashflower package is open-source. Everyone can use it and contribute to its development.

GitHub repository:

https://github.com/acturtle/cashflower

Documentation:

https://cashflower.acturtle.com

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

cashflower-0.5.1.tar.gz (15.0 kB view hashes)

Uploaded Source

Built Distribution

cashflower-0.5.1-py3-none-any.whl (15.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page