Metadata-Version: 2.4
Name: pyabf
Version: 2.3.8
Summary: Python library for reading files in Axon Binary Format (ABF)
Home-page: http://swharden.com/pyabf
Author: Scott W Harden
Author-email: SWHarden@gmail.com
License: MIT License
Project-URL: Bug Reports, https://github.com/swharden/pyABF/issues
Project-URL: Source, https://github.com/swharden/pyABF
Project-URL: Documentation, https://swharden.com/pyabf/tutorial
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.8
License-File: LICENSE
Requires-Dist: matplotlib>=2.1.0
Requires-Dist: numpy>=1.13.3
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

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

|
