Metadata-Version: 2.0
Name: matrixutils
Version: 0.0.1
Summary: utilities for working with matrices as linear operators in python
Home-page: http://simpeg.xyz/
Author: OpenGeophysics Developers
Author-email: admin@simpeg.xyz
License: MIT
Download-URL: https://github.com/OpenGeophysics/matrixutils
Description-Content-Type: UNKNOWN
Keywords: finite volume,discretization,pde,ode
Platform: Windows
Platform: Linux
Platform: Solaris
Platform: Mac OS-X
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Natural Language :: English
Requires-Dist: cython
Requires-Dist: matplotlib
Requires-Dist: numpy (>=1.7)
Requires-Dist: properties (>=0.3.6b0)
Requires-Dist: scipy (>=0.13)

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/OpenGeopyhsics/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&amp;utm_medium=referral&amp;utm_content=opengeophysics/matrixutils&amp;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/



