Skip to main content

Elizur is a finance library for actuaries, finance professionals, and students.

Project description

elizur.

License: GPL v3 Build Status PyPI version Coverage Status Code style: black

Elizur is an open source finance library for actuaries, finance professionals, and students. The library currently helps with calculating present values, future values, expected present values, life contingencies, and other common procedures performed by professionals and students. The library is free of charge, open source, well tested, documented, and depends only on the Python 3 standard library at runtime. The Elizur project is named after Elizur Wright.

If you like Elizur, support the project by clicking the :star: above!

Requirements

Install

pip install elizur

Documentation

Read the library documentation here

Examples

Given an interest rate calculate a discount factor

>>> import elizur.life.annuity as ann
>>> ann.discount_factor(0.07)
0.9345794

Given a term and interest rate calculate the present value of an annuity

>>> import elizur.life.annuity as ann
>>> ann.annuity_pv(n=10, i=0.07)
7.023581540932602

Given a term and interest rate calculate the present value of an annuity increasing by one each period

>>> import elizur.life.annuity as ann
>>> ann.increasing_annuity_pv(n=10, i=0.07)
34.73913324929581

Given a mortality table calculate life contingencies and probabilities

>>> from elizur.life.table import LifeTable, EXAMPLE_TABLE
>>> life_table = LifeTable(EXAMPLE_TABLE)
>>> life_table.qx(0)
0.006271
>>> life_table.qx(77)
0.036094
>>> life_table.tqxn(3, 2, 77)
0.08770141840040623
>>> life_table.Ax(0, 0.07)
0.01562517028789102
>>> life_table.IAxn(0, 0.07, 30)
0.04871771529491165
>>> life_table.ax(0, 0.07)
14.046872397027947
>>> life_table.axn_due(0, 0.07, 30)
13.173054007415931

Given a set of cash flows, probabilities, and interest rates calculate the expected present value

>>> from elizur.life import expected_present_value
>>> expected_present_value(
>>>    cash_flows=(10, 11, 12),
>>>    probabilities=(0.99, 0.98, 0.97),
>>>    interest_rates=(0.05, 0.06, 0.07)
>>> )
28.88814436019514

Import a mortality table in a specific SOA CSV format and perform life contingency calculations. Download a mortality table in csv format from the SOA here. This example uses the first table, 1941 CSO Basic Table ANB.

>>> from elizur.life.util import read_soa_csv_mort_table  
>>> from elizur.life.table import LifeTable
>>> mort_table = read_soa_csv_table("1941_cso_basic_table_anb.csv")
>>> life_table = LifeTable(mort_table["values"])
>>> life_table.qx(77)
0.10364
>>> life_table.Ax(0, 0.07)
0.03800673925889163

There are many other possibilities. Check out the reference section of the docs for a full list of functionality.

Chat

If you have questions, suggestions, or just want to talk about using Python join us on Slack here.

Contributing

Do you want to help this project without contributing code? Take our survey here.

Otherwise checkout the contributing guide here if you like to contribute code or raise issues.

New to Python?

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for elizur, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size elizur-0.1.2-py3-none-any.whl (20.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size elizur-0.1.2.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page