numpy-financial 1.0.0

The numpy-financial package is a collection of elementary financial functions.

The financial functions in NumPy are deprecated and eventually will be removed from NumPy; see NEP-32 for more information. This package is the replacement for the deprecated NumPy financial functions.

The source code for this package is available at https://github.com/numpy/numpy-financial.

The importable name of the package is numpy_financial. The recommended alias is npf. For example,

>>> import numpy_financial as npf
>>> npf.irr([-250000, 100000, 150000, 200000, 250000, 300000])
0.5672303344358536

Functions

fv(rate, nper, pmt, pv[, when])

Compute the future value.

ipmt(rate, per, nper, pv[, fv, when])

Compute the interest portion of a payment.

irr(values)

Return the Internal Rate of Return (IRR).

mirr(values, finance_rate, reinvest_rate)

Modified internal rate of return.

nper(rate, pmt, pv[, fv, when])

Compute the number of periodic payments.

npv(rate, values)

Returns the NPV (Net Present Value) of a cash flow series.

pmt(rate, nper, pv[, fv, when])

Compute the payment against loan principal plus interest.

ppmt(rate, per, nper, pv[, fv, when])

Compute the payment against loan principal.

pv(rate, nper, pmt[, fv, when])

Compute the present value.

rate(nper, pmt, pv, fv[, when, guess, tol, …])

Compute the rate of interest per period.

Release Notes

1.0.0

  • The transition of the source code from NumPy to this package is complete.

0.2.0

  • Removed the use of numpy.core.overrides.array_function_dispatch to create wrappers of the financial functions.

  • Support NumPy versions back to 1.15.

0.1.0

  • This is the initial release of numpy-financial. The functions were copied from NumPy 1.17.