Metadata-Version: 2.1
Name: matrixprofile
Version: 1.0.1
Summary: An open source time series data mining library based on Matrix Profile algorithms.
Home-page: https://github.com/matrix-profile-foundation/matrixprofile
Author: Matrix Profile Foundation
Author-email: tylerwmarrs@gmail.com
License: UNKNOWN
Project-URL: Matrix Profile Foundation, https://matrixprofile.org
Project-URL: Source Code, https://github.com/matrix-profile-foundation/matrixprofile
Keywords: matrix profile time series discord motif analysis data science anomaly pattern
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/x-rst
Requires-Dist: numpy (>=1.16.2)
Requires-Dist: matplotlib (>=3.0.3)
Requires-Dist: protobuf (==3.11.2)

===============================
 MatrixProfile Documentation
===============================

.. image:: https://img.shields.io/pypi/v/matrixprofile.svg
    :target: https://pypi.org/project/matrixprofile/
    :alt: PyPI Version
.. image:: https://pepy.tech/badge/matrixprofile
    :target: https://pepy.tech/project/matrixprofile
    :alt: PyPI Downloads
.. image:: https://codecov.io/gh/matrix-profile-foundation/matrixprofile/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/matrix-profile-foundation/matrixprofile
    :alt: Code Coverage
.. image:: https://travis-ci.com/matrix-profile-foundation/matrixprofile.svg
    :target: https://travis-ci.com/matrix-profile-foundation/matrixprofile
    :alt: Build Status
.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
    :target: https://opensource.org/licenses/Apache-2.0
    :alt: License
.. image:: https://img.shields.io/twitter/follow/matrixprofile.svg?style=social
    :target: https://twitter.com/matrixprofile
    :alt: Twitter

|

.. image:: https://matrixprofile.org/static/img/mpf-logo.png
    :target: https://matrixprofile.org
    :height: 300px
    :scale: 50%
    :alt: MPF Logo

MatrixProfile
----------------
MatrixProfile is a Python 2 and 3 library, brought to you by the `Matrix Profile Foundation <https://matrixprofile.org>`_, for mining time series data. The Matrix Profile is a novel data structure developed by the `Keogh <https://www.cs.ucr.edu/~eamonn/MatrixProfile.html>`_ and `Mueen <https://www.cs.unm.edu/~mueen/>`_ research groups at UC-Riverside and the University of New Mexico. The goal of this library is to make these algorithms accessible to both the novice and expert.

In addition to this Python library, the Matrix Profile Foundation, provides implementations in other languages. These languages have a pretty consistent API allowing you to easily switch between them without a huge learning curve.

* `tsmp <https://github.com/matrix-profile-foundation/tsmp>`_ - an R implementation
* `go-matrixprofile <https://github.com/matrix-profile-foundation/go-matrixprofile>`_ - a Golang implementation

Installation
------------
The easiest way to install this library is using pip. If you would like to install it from source, please review the `installation documentation <http://matrixprofile.docs.matrixprofile.org/install.html>`_ for your platform.

.. code-block:: bash

   pip install matrixprofile

Getting Started
---------------
This article provides introductory material on the Matrix Profile:
`Introduction to Matrix Profiles  <https://towardsdatascience.com/introduction-to-matrix-profiles-5568f3375d90>`_


This article provides details about core concepts introduced in this library:
`How To Painlessly Analyze Your Time Series  <https://towardsdatascience.com/how-to-painlessly-analyze-your-time-series-f52dab7ea80d>`_

Our documentation provides a `quick start guide <http://matrixprofile.docs.matrixprofile.org/Quickstart.html>`_, `examples <http://matrixprofile.docs.matrixprofile.org/examples.html>`_ and `api <http://matrixprofile.docs.matrixprofile.org/api.html>`_ documentation. It is the source of truth for getting up and running.

Algorithms
----------
For details about the algorithms implemented, including performance characteristics, please refer to the `documentation <http://matrixprofile.docs.matrixprofile.org/Algorithms.html>`_.

------------
Getting Help
------------
We provide a dedicated `Discord channel <https://discordapp.com/invite/sBhDNXT>`_ where practitioners can discuss applications and ask questions about the Matrix Profile Foundation libraries. If you rather not join Discord, then please open a `Github issue <https://github.com/matrix-profile-foundation/matrixprofile/issues>`_.

------------
Contributing
------------
Please review the `contributing guidelines <http://matrixprofile.docs.matrixprofile.org/contributing.html>`_ located in our documentation.

---------------
Code of Conduct
---------------
Please review our `Code of Conduct documentation <http://matrixprofile.docs.matrixprofile.org/code_of_conduct.html>`_.

---------
Citations
---------
All proper acknowledgements for works of others may be found in our `citaiton documentation <http://matrixprofile.docs.matrixprofile.org/citations.html>`_.


