https://github.com/acturtle/cashflower

An open-source Python framework for actuarial cash flow models
https://github.com/acturtle/cashflower

actuarial-modeling actuarial-science actuary financial-modeling python quantitative-finance

Last synced: about 2 months ago
JSON representation

An open-source Python framework for actuarial cash flow models

• Host: GitHub
• URL: https://github.com/acturtle/cashflower
• Owner: acturtle
• License: mit
• Created: 2022-06-27T06:47:17.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-24T09:11:30.000Z (about 2 months ago)
• Last Synced: 2024-11-24T09:27:40.456Z (about 2 months ago)
• Topics: actuarial-modeling, actuarial-science, actuary, financial-modeling, python, quantitative-finance
• Language: Python
• Homepage: https://cashflower.acturtle.com
• Size: 2.3 MB
• Stars: 38
• Watchers: 4
• Forks: 9
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - acturtle/cashflower - An open-source Python framework for actuarial cash flow models (Python)

README

        
[![PyPI Latest Release](https://img.shields.io/pypi/v/cashflower.svg)](https://pypi.org/project/cashflower/)

[![pytest](https://github.com/acturtle/cashflower/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/acturtle/cashflower/actions/workflows/pytest.yml)

[![Documentation Status](https://readthedocs.org/projects/cashflower/badge/)](https://cashflower.acturtle.com)

# Info

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

## Installation

*terminal*

```

pip install cashflower

```

## Create model

*python console*

```python

from cashflower import create_model

create_model("my_model")

```

Creates:

```

my_model/

    input.py

    model.py

    run.py

    settings.py

```

## Model

*my_model/model.py*

```python

from cashflower import variable

@variable()

def survival_probability(t):

    mortality_rate = 0.01

    if t == 0:

        return 1

    return survival_probability(t - 1) * (1 - mortality_rate)

```

## Calculate

*terminal*

```

python run.py

```

# Contribution

GitHub repository:

[https://github.com/acturtle/cashflower](https://github.com/acturtle/cashflower)

Documentation:

[https://cashflower.acturtle.com](https://cashflower.acturtle.com)