Quick search


version 0.3.1

Python interface to UMFPACK sparse direct solver.

People: Robert Cimrman



scikit-umfpack provides wrapper of UMFPACK sparse direct solver to


.. code:: python

>>> from scikits.umfpack import spsolve, splu
>>> lu = splu(A)
>>> x = spsolve(A, b)

Installing scikits.umfpack also enables using UMFPACK solver via some of
the scipy.sparse.linalg functions, for SciPy >= 0.14.0. Note you will
need to have installed UMFPACK before hand. UMFPACK is parse of
`SuiteSparse <>`__.


scikit-umfpack depends on NumPy, SciPy, SuiteSparse, and swig is a
build-time dependency.

Building SuiteSparse

SuiteSparse may be available from your package manager or as a prebuilt
shared library. If that is the case use that if possible. Installation
on Ubuntu 14.04 can be achieved with


sudo apt-get install libsuitesparse-dev

Otherwise, you will need to build from source. Unfortunately,
SuiteSparse's makefiles do not support building a shared library out of
the box. You may find `Stefan F\xfcrtinger instructions
helpful <>`__.

Furthmore, building METIS-4.0, an optional but important compile time
dependency of SuiteSparse, has problems on newer GCCs. This `patch and
instructions <>`__
from Nadir Soualem are helpful for getting a working METIS build.

Otherwise, I commend you to the documentation.


.. include-start

Releases of scikit-umfpack can be installed using ``pip``. For a system-wide
installation run::

pip install --upgrade scikit-umfpack

or for a user installation run ::

pip install --upgrade --user scikit-umfpack

To install scikit-umfpack from its source code directory, run in that
directory (``--user`` means a user installation)::

pip install --upgrade --user .

.. include-end



You can check the latest sources with the command:


git clone

or if you have write privileges:


git clone


After installation, you can launch the test suite from outside the
source directory (you will need to have the ``nose`` package installed):


nosetests -v scikits.umfpack



You can download the latest distribution from PyPI here:

Using pip

You can install scikit-umfpack for yourself from the terminal by running:

pip install --user scikit-umfpack

If you want to install it for all users on your machine, do:

pip install scikit-umfpack
On Linux, do sudo pip install scikit-umfpack.

If you don't yet have the pip tool, you can get it following these instructions.

This package was discovered in PyPI.