Skip to content

FCS-analysis/multipletau

Repository files navigation

multipletau

PyPI Version Tests Status Coverage Status Docs Status

Multiple-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.7 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

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):