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


Welcome to the cashflower documentation, your resource for financial and actuarial cash flow modeling with Python. Cashflower simplifies complex financial scenarios, allowing actuaries, analysts, and developers to make data-driven decisions effectively.

Cashflower’s flexible framework empowers you to model various financial scenarios, from insurance policies and annuities to investment portfolios and loans. This documentation is here to assist you in understanding and using the package to achieve your financial modeling goals.

Key features#

Cashflower’s features:
  • easy to use - run your first cash flow model with just few commands,

  • open source - freely accessible to all users and available on PyPI,

  • flexible - integrate your project with other popular Python libraries.

Rapid start#

You’re just a few commands away from running your first cash flow model with cashflower:

$ pip install cashflower
$ python
>>> from cashflower import create_model
>>> create_model("mymodel")
>>> quit()
$ cd mymodel
$ python

Congratulations, you’re all set!

Getting Started#

To get started with the cashflower package, follow these steps:
  1. Quick Start: Get up and running quickly with the Getting started section.

  2. Tutorials: Check out our collection of practical examples in the Tutorials section.

  3. Discussions: If you encounter any issues, share your thoughts in the Discussions page.

Cheat sheet#

A cheat sheet is a quick-reference document that provides essential code snippets and syntax examples.

You can download the Cashflower cheat sheet (PDF).


Cashflower is distributed under the MIT License.

Contributions and Support#

Cashflower is an open-source project, and we welcome contributions from the community. If you encounter any issues, have suggestions, or want to contribute to the development, please visit our GitHub repository.