matrixutils

.. image:: https://img.shields.io/pypi/v/matrixutils.svg :target: https://pypi.python.org/pypi/matrixutils :alt: Latest PyPI version

.. image:: https://readthedocs.org/projects/matrixutils/badge/?version=latest :target: http://matrixutils.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://img.shields.io/github/license/opengeophysics/matrixutils.svg :target: https://github.com/opengeophysics/matrixutils/blob/master/LICENSE :alt: MIT license

.. image:: https://api.travis-ci.org/opengeophysics/matrixutils.svg?branch=master :target: https://travis-ci.org/opengeophysics/matrixutils :alt: Travis CI build status

.. image:: https://codecov.io/gh/opengeophysics/matrixutils/branch/master/graph/badge.svg :target: https://codecov.io/gh/opengeophysics/matrixutils :alt: Coverage status

.. image:: https://api.codacy.com/project/badge/Grade/0e5f3204fc3c4e989f41e74caf5c6084 :target: https://www.codacy.com/app/lindseyheagy/matrixutils?utm_source=github.com&utm_medium=referral&utm_content=opengeophysics/matrixutils&utm_campaign=Badge_Gradetus :alt: Code quality

Why

matrixutils is a python package that includes utilities for working with matrices as linear operators in python. It includes utilities for wrapping and unwrapping matrices and vectors, tools for creating matrices, and operators Zero and Identity which improve code efficiency without sacrificing readability.

It is used by discretize <https://github.com/simpeg/discretize> and SimPEG <https://github.com/simpeg/simpeg>.

Installation

.. code:: shell

pip install matrixutils

To install as a developer

.. code:: shell

git clone https://github.com/opengeophysics/matrixutils.git
cd matrixutils
python setup.py install

or to build the installation in-place:

.. code:: shell

git clone https://github.com/opengeophysics/matrixutils.git
cd matrixutils
python setup.py install build_ext --inplace

Links

Website: http://simpeg.xyz

Documentation: http://matrixutils.readthedocs.io

Code: https://github.com/opengeophysics/matrixutils

Tests: Coming soon...

Bugs & Issues: https://github.com/opengeophysics/matrixutils/issues

Questions: https://groups.google.com/forum/#!forum/simpeg

Chat: http://slack.simpeg.xyz/