Skip to main content

A multiple-tau algorithm for Python/NumPy.

Project description

PyPI Version Tests Status Coverage Status Docs Status

Multipe-tau correlation is computed on a logarithmic scale (less data points are computed) and is thus much faster than conventional correlation on a linear scale such as numpy.correlate.

Installation

Multipletau supports Python 2.6+ and Python 3.3+ with a common codebase. The only requirement for multipletau is NumPy (for fast operations on arrays). Install multipletau from the Python package index:

pip install multipletau

Documentation

The documentation, including the reference and examples, is available on readthedocs.io.

Usage

import numpy as np
import multipletau
a = np.linspace(2,5,42)
v = np.linspace(1,6,42)
multipletau.correlate(a, v, m=2)
array([[   0.        ,  569.56097561],
       [   1.        ,  549.87804878],
       [   2.        ,  530.37477692],
       [   4.        ,  491.85812017],
       [   8.        ,  386.39500297]])

Citing

The multipletau package should be cited like this (replace “x.x.x” with the actual version of multipletau that you used and “DD Month YYYY” with a matching date).

Paul Müller (2012) Python multiple-tau algorithm (Version x.x.x) [Computer program]. Available at https://pypi.python.org/pypi/multipletau/ (Accessed DD Month YYYY)

You can find out what version you are using by typing (in a Python console):

>>> import multipletau
>>> multipletau.__version__
'0.1.4'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
multipletau-0.1.9-py2.py3-none-any.whl (12.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Oct 3, 2017
multipletau-0.1.9.tar.gz (90.2 kB) Copy SHA256 hash SHA256 Source None Oct 3, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page