pyabf


Namepyabf JSON
Version 2.3.8 PyPI version JSON
download
home_pagehttp://swharden.com/pyabf
SummaryPython library for reading files in Axon Binary Format (ABF)
upload_time2023-08-02 23:21:56
maintainer
docs_urlNone
authorScott W Harden
requires_python>=3.8
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            pyABF: a pure-Python ABF file reader
====================================

**pyABF** provides a Python interface to electrophysiology files in the Axon Binary Format (ABF).
pyABF supports Python 3 and does not use obscure libraries (just numpy and matplotlib). 
pyABF supports reading ABF1 and ABF2 files and can write ABF1 files.

.. class:: no-web

    .. image:: http://swharden.com/pyabf/graphics/action-potentials-small.png
        :alt: pyABF electrophysiology data analysis with Python and Matplotlib
        :align: center

Quickstart
==========

Install or upgrade pyABF:

.. code-block:: bash

    pip install --upgrade pyabf

|

Access ABF sweep data:

.. code-block:: python

  import pyabf
  abf = pyabf.ABF("demo.abf")
  abf.setSweep(sweepNumber=3, channel=0)
  print(abf.sweepY) # displays sweep data (ADC)
  print(abf.sweepX) # displays sweep times (seconds)
  print(abf.sweepC) # displays command waveform (DAC)

|

Plot a sweep with Matplotlib:

.. code-block:: python

  import pyabf
  import matplotlib.pyplot as plt
  abf = pyabf.ABF("demo.abf")
  abf.setSweep(14)
  plt.plot(abf.sweepX, abf.sweepY)
  plt.show()

.. class:: no-web

    .. image:: http://swharden.com/pyabf/graphics/pyabf-example-sweep.jpg
        :alt: pyABF Example
        :align: center

|


Additional Examples
===================
Full pyabf API documentation, additional code examples, a pyabf cookbook, 
and low-level information about the ABF file format can be found at the pyABF 
project homepage: http://swharden.com/pyabf/

.. class:: no-web

    .. image:: http://swharden.com/pyabf/graphics/pyabf-example-action-potentials.jpg
        :alt: pyABF Example
        :align: center

|

            

Raw data

            {
    "_id": null,
    "home_page": "http://swharden.com/pyabf",
    "name": "pyabf",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Scott W Harden",
    "author_email": "SWHarden@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/08/8c/60694c3129f22766e69e413c8172a263a46f363a99498da63bda411cfe28/pyabf-2.3.8.tar.gz",
    "platform": "any",
    "description": "pyABF: a pure-Python ABF file reader\n====================================\n\n**pyABF** provides a Python interface to electrophysiology files in the Axon Binary Format (ABF).\npyABF supports Python 3 and does not use obscure libraries (just numpy and matplotlib). \npyABF supports reading ABF1 and ABF2 files and can write ABF1 files.\n\n.. class:: no-web\n\n    .. image:: http://swharden.com/pyabf/graphics/action-potentials-small.png\n        :alt: pyABF electrophysiology data analysis with Python and Matplotlib\n        :align: center\n\nQuickstart\n==========\n\nInstall or upgrade pyABF:\n\n.. code-block:: bash\n\n    pip install --upgrade pyabf\n\n|\n\nAccess ABF sweep data:\n\n.. code-block:: python\n\n  import pyabf\n  abf = pyabf.ABF(\"demo.abf\")\n  abf.setSweep(sweepNumber=3, channel=0)\n  print(abf.sweepY) # displays sweep data (ADC)\n  print(abf.sweepX) # displays sweep times (seconds)\n  print(abf.sweepC) # displays command waveform (DAC)\n\n|\n\nPlot a sweep with Matplotlib:\n\n.. code-block:: python\n\n  import pyabf\n  import matplotlib.pyplot as plt\n  abf = pyabf.ABF(\"demo.abf\")\n  abf.setSweep(14)\n  plt.plot(abf.sweepX, abf.sweepY)\n  plt.show()\n\n.. class:: no-web\n\n    .. image:: http://swharden.com/pyabf/graphics/pyabf-example-sweep.jpg\n        :alt: pyABF Example\n        :align: center\n\n|\n\n\nAdditional Examples\n===================\nFull pyabf API documentation, additional code examples, a pyabf cookbook, \nand low-level information about the ABF file format can be found at the pyABF \nproject homepage: http://swharden.com/pyabf/\n\n.. class:: no-web\n\n    .. image:: http://swharden.com/pyabf/graphics/pyabf-example-action-potentials.jpg\n        :alt: pyABF Example\n        :align: center\n\n|\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Python library for reading files in Axon Binary Format (ABF)",
    "version": "2.3.8",
    "project_urls": {
        "Bug Reports": "https://github.com/swharden/pyABF/issues",
        "Documentation": "https://swharden.com/pyabf/tutorial",
        "Homepage": "http://swharden.com/pyabf",
        "Source": "https://github.com/swharden/pyABF"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b428b05be29bc66faa4683b18aaa67cb24edde881f54b0e368adf8975b78fd02",
                "md5": "0ca98af9c8d50514dd9cc389ad44af80",
                "sha256": "32c59da0db9afdb69568b6bd0f8aa4b409193fe325a461d906c6ae22e5bff391"
            },
            "downloads": -1,
            "filename": "pyabf-2.3.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0ca98af9c8d50514dd9cc389ad44af80",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 53007,
            "upload_time": "2023-08-02T23:21:55",
            "upload_time_iso_8601": "2023-08-02T23:21:55.164023Z",
            "url": "https://files.pythonhosted.org/packages/b4/28/b05be29bc66faa4683b18aaa67cb24edde881f54b0e368adf8975b78fd02/pyabf-2.3.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "088c60694c3129f22766e69e413c8172a263a46f363a99498da63bda411cfe28",
                "md5": "e6131e2248de1c4340eb9477b69a60a1",
                "sha256": "4a4cf5701149eed75adc4dc8ea975c61c43c1678e5bcf468426140ec52302109"
            },
            "downloads": -1,
            "filename": "pyabf-2.3.8.tar.gz",
            "has_sig": false,
            "md5_digest": "e6131e2248de1c4340eb9477b69a60a1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 44207,
            "upload_time": "2023-08-02T23:21:56",
            "upload_time_iso_8601": "2023-08-02T23:21:56.906002Z",
            "url": "https://files.pythonhosted.org/packages/08/8c/60694c3129f22766e69e413c8172a263a46f363a99498da63bda411cfe28/pyabf-2.3.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-02 23:21:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "swharden",
    "github_project": "pyABF",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyabf"
}
        
Elapsed time: 0.25569s