Skip to main content

pentapy: A toolbox for pentadiagonal matrizes.

Project description

Welcome to pentapy

status DOI PyPI version Build Status Coverage Status Documentation Status Code style: black

Purpose

pentapy is a toolbox to deal with pentadiagonal matrices in Python.

Pentadiagonal linear equation systems arise in many areas of science and engineering: e.g. when solving differential equations, in interpolation problems, or in numerical schemes like finite difference.

Installation

The package can be installed via pip. On Windows you can install WinPython to get Python and pip running.

pip install pentapy

There are pre-built wheels for Linux, MacOS and Windows for most Python versions (2.7, 3.4-3.7).

If your system is not supported and you want to have the Cython routines of pentapy installed, you have to provide a c-compiler and run:

pip install numpy cython
pip install pentapy

To get the scipy solvers running, you have to install scipy or you can use the following extra argument:

pip install pentapy[all]

Instead of "all" you can also typ "scipy" or "umfpack" to get one of these specific packages.

Citation

If you use pentapy in your publication, please cite it:

Müller, (2019). pentapy: A Python toolbox for pentadiagonal linear systems. Journal of Open Source Software, 4(42), 1759, https://doi.org/10.21105/joss.01759

To cite a certain release, have a look at the Zenodo site: https://doi.org/10.5281/zenodo.2587158

References

The solver is based on the algorithms PTRANS-I and PTRANS-II presented by Askar et al. 2015.

Documentation and Examples

You can find the documentation under geostat-framework.readthedocs.io.

Solving a pentadiagonal linear equation system

This is an example of how to solve a LES with a pentadiagonal matrix.

import numpy as np
import pentapy as pp

size = 1000
# create a flattened pentadiagonal matrix
M_flat = (np.random.random((5, size)) - 0.5) * 1e-5
V = np.random.random(size) * 1e5
# solve the LES with M_flat as row-wise flattened matrix
X = pp.solve(M_flat, V, is_flat=True)

# create the corresponding matrix for checking
M = pp.create_full(M_flat, col_wise=False)
# calculate the error
print(np.max(np.abs(np.dot(M, X) - V)))

This should give something like:

4.257890395820141e-08

Performance

In the following a couple of solvers for pentadiagonal systems are compared:

Performance

The implementations of pentapy are almost one order of magnitude faster than the scipy algorithms for banded or sparse matrices.

The performance plot was created with perfplot. Have a look at the script: examples/03_perform_simple.py.

Requirements:

Optional

Contact

You can contact us via info@geostat-framework.org.

License

MIT © 2019 - 2020

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 pentapy, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pentapy-1.1.0-cp35-cp35m-macosx_10_9_x86_64.whl (206.1 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size pentapy-1.1.0-cp35-cp35m-manylinux1_i686.whl (393.2 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size pentapy-1.1.0-cp35-cp35m-manylinux1_x86_64.whl (476.7 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size pentapy-1.1.0-cp35-cp35m-manylinux2010_i686.whl (393.2 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size pentapy-1.1.0-cp35-cp35m-manylinux2010_x86_64.whl (476.7 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size pentapy-1.1.0-cp35-cp35m-win32.whl (188.8 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size pentapy-1.1.0-cp35-cp35m-win_amd64.whl (204.9 kB) File type Wheel Python version cp35 Upload date Hashes View
Filename, size pentapy-1.1.0-cp36-cp36m-macosx_10_9_x86_64.whl (208.7 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pentapy-1.1.0-cp36-cp36m-manylinux1_i686.whl (398.5 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pentapy-1.1.0-cp36-cp36m-manylinux1_x86_64.whl (484.1 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pentapy-1.1.0-cp36-cp36m-manylinux2010_i686.whl (398.5 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pentapy-1.1.0-cp36-cp36m-manylinux2010_x86_64.whl (484.1 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pentapy-1.1.0-cp36-cp36m-win32.whl (189.7 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pentapy-1.1.0-cp36-cp36m-win_amd64.whl (206.0 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pentapy-1.1.0-cp37-cp37m-macosx_10_9_x86_64.whl (208.7 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pentapy-1.1.0-cp37-cp37m-manylinux1_i686.whl (398.7 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pentapy-1.1.0-cp37-cp37m-manylinux1_x86_64.whl (484.0 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pentapy-1.1.0-cp37-cp37m-manylinux2010_i686.whl (398.7 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pentapy-1.1.0-cp37-cp37m-manylinux2010_x86_64.whl (484.0 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pentapy-1.1.0-cp37-cp37m-win32.whl (189.6 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pentapy-1.1.0-cp37-cp37m-win_amd64.whl (206.0 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pentapy-1.1.0-cp38-cp38-macosx_10_9_x86_64.whl (209.8 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size pentapy-1.1.0-cp38-cp38-manylinux1_i686.whl (430.9 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size pentapy-1.1.0-cp38-cp38-manylinux1_x86_64.whl (532.1 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size pentapy-1.1.0-cp38-cp38-manylinux2010_i686.whl (430.9 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size pentapy-1.1.0-cp38-cp38-manylinux2010_x86_64.whl (532.1 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size pentapy-1.1.0-cp38-cp38-win32.whl (190.5 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size pentapy-1.1.0-cp38-cp38-win_amd64.whl (206.4 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size pentapy-1.1.0.tar.gz (236.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page