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 <http://docs.scipy.org/doc/numpy/reference/generated/numpy.correlate.html>`__.
Installation
------------
The only requirement for ``multipletau`` is Python 3.x and
`NumPy <http://www.numpy.org/>`__. Install multipletau from the
Python package index:
::
pip install multipletau
Documentation
-------------
The documentation, including the reference and examples, is available
on `readthedocs.io <https://multipletau.readthedocs.io/en/stable/>`__.
Usage
-----
.. code:: python
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):
.. code:: python
>>> import multipletau
>>> multipletau.__version__
'0.4.0'
.. |PyPI Version| image:: https://img.shields.io/pypi/v/multipletau.svg
:target: https://pypi.python.org/pypi/multipletau
.. |Tests Status| image:: https://img.shields.io/github/actions/workflow/status/FCS-analysis/multipletau/check.yml
:target: https://github.com/FCS-analysis/multipletau/actions?query=workflow%3AChecks
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/FCS-analysis/multipletau/master.svg
:target: https://codecov.io/gh/FCS-analysis/multipletau
.. |Docs Status| image:: https://readthedocs.org/projects/multipletau/badge/?version=latest
:target: https://readthedocs.org/projects/multipletau/builds/
Raw data
{
"_id": null,
"home_page": null,
"name": "multipletau",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.6",
"maintainer_email": "Paul M\u00fcller <dev@craban.de>",
"keywords": "multiple tau, fluorescence correlation spectroscopy",
"author": "Andr\u00e9 Scholich, Alexandre Detiste, Chris Lamb, Pascal Hebbeker, Paul M\u00fcller",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/95/d7/fecccb434dfda27460e3ee6dfc9be1e650389afafe302ae7fe59d3a86e5b/multipletau-0.4.1.tar.gz",
"platform": null,
"description": "multipletau\n===========\n\n|PyPI Version| |Tests Status| |Coverage Status| |Docs Status|\n\nMultiple-tau correlation is computed on a logarithmic scale (less\ndata points are computed) and is thus much faster than conventional\ncorrelation on a linear scale such as `numpy.correlate <http://docs.scipy.org/doc/numpy/reference/generated/numpy.correlate.html>`__. \n\n\nInstallation\n------------\nThe only requirement for ``multipletau`` is Python 3.x and\n`NumPy <http://www.numpy.org/>`__. Install multipletau from the\nPython package index:\n\n::\n\n pip install multipletau\n\n\nDocumentation\n-------------\n\nThe documentation, including the reference and examples, is available\non `readthedocs.io <https://multipletau.readthedocs.io/en/stable/>`__.\n\n\nUsage\n-----\n\n.. code:: python\n\n import numpy as np\n import multipletau\n a = np.linspace(2,5,42)\n v = np.linspace(1,6,42)\n multipletau.correlate(a, v, m=2)\n array([[ 0. , 569.56097561],\n \t [ 1. , 549.87804878],\n [ 2. , 530.37477692],\n [ 4. , 491.85812017],\n [ 8. , 386.39500297]])\n\n\nCiting\n------\nThe multipletau package should be cited like this\n(replace \"x.x.x\" with the actual version of multipletau that you used\nand \"DD Month YYYY\" with a matching date).\n\nPaul M\u00fcller (2012) *Python multiple-tau algorithm* (Version x.x.x) [Computer program]. Available at `<https://pypi.python.org/pypi/multipletau/>`__ (Accessed DD Month YYYY)\n\nYou can find out what version you are using by typing (in a Python console):\n\n.. code:: python\n\n >>> import multipletau\n >>> multipletau.__version__\n '0.4.0'\n\n\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/multipletau.svg\n :target: https://pypi.python.org/pypi/multipletau\n.. |Tests Status| image:: https://img.shields.io/github/actions/workflow/status/FCS-analysis/multipletau/check.yml\n :target: https://github.com/FCS-analysis/multipletau/actions?query=workflow%3AChecks\n.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/FCS-analysis/multipletau/master.svg\n :target: https://codecov.io/gh/FCS-analysis/multipletau\n.. |Docs Status| image:: https://readthedocs.org/projects/multipletau/badge/?version=latest\n :target: https://readthedocs.org/projects/multipletau/builds/\n",
"bugtrack_url": null,
"license": "BSD (3 clause)",
"summary": "A multiple-tau algorithm for Python/NumPy",
"version": "0.4.1",
"project_urls": {
"changelog": "https://multipletau.readthedocs.io/en/stable/#changelog",
"documentation": "https://multipletau.readthedocs.io/en/stable/",
"source": "https://github.com/FCS-analysis/multipletau",
"tracker": "https://github.com/FCS-analysis/multipletau/issues"
},
"split_keywords": [
"multiple tau",
" fluorescence correlation spectroscopy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbb41c8108c7eb1bd1cc28045c9986709760ff4f758b3e31e0c17d1120f7e7fa",
"md5": "e8cc247ed3d049ff552fd391c7815487",
"sha256": "b97750c03b5d00ba56d90eeb5113f13216a04b65a2abb0f175cd55b85c4782f3"
},
"downloads": -1,
"filename": "multipletau-0.4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8cc247ed3d049ff552fd391c7815487",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "<4,>=3.6",
"size": 10489,
"upload_time": "2024-06-27T08:15:26",
"upload_time_iso_8601": "2024-06-27T08:15:26.084329Z",
"url": "https://files.pythonhosted.org/packages/cb/b4/1c8108c7eb1bd1cc28045c9986709760ff4f758b3e31e0c17d1120f7e7fa/multipletau-0.4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95d7fecccb434dfda27460e3ee6dfc9be1e650389afafe302ae7fe59d3a86e5b",
"md5": "f2675ffc708d0ba8f8121e5f7619cef3",
"sha256": "ae83f7e3615b8d6284b71df62927ba21b832d1e8b02c782aa05c175259ee54ef"
},
"downloads": -1,
"filename": "multipletau-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "f2675ffc708d0ba8f8121e5f7619cef3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.6",
"size": 94819,
"upload_time": "2024-06-27T08:15:29",
"upload_time_iso_8601": "2024-06-27T08:15:29.230888Z",
"url": "https://files.pythonhosted.org/packages/95/d7/fecccb434dfda27460e3ee6dfc9be1e650389afafe302ae7fe59d3a86e5b/multipletau-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 08:15:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FCS-analysis",
"github_project": "multipletau",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "multipletau"
}
JSON
