Metadata-Version: 2.1
Name: abf-explorer
Version: 0.5
Summary: A PyQt GUI to quickly visualize ABF electrophysiology files
Home-page: https://github.com/nkicg6/ABF_Explorer
Author: Nick George
Author-email: nicholas.george32@gmail.com
License: GPL v3
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.7
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy (==1.19.4)
Requires-Dist: PyQt5 (==5.15.1)
Requires-Dist: pyqtgraph (==0.11.0)
Requires-Dist: pyabf (==2.2.8)

# ABF Explorer

`ABF_Explorer` is a **simple** app for quickly viewing axon binary format (ABF) files from electrophysiology experiments without writing a bunch of python/matlab/etc. boilerplate. This graphical tool allows you to quickly scroll through files, read the metadata, and take a look at the data.

![ABF_Explorer UI](https://github.com/nkicg6/ABF_Explorer/raw/master/docs/img/abfexplorer-example.png "ABF Explorer UI")

We use the excellent pyABF package (https://github.com/swharden/pyABF) by [Scott W Harden](https://github.com/swharden) to do the hard work of parsing ABF files.

# Use

This is a graphical application for inspecting physiology data in ABF files. ABF Explorer supports Python > 3.7.

## Install

```bash
pip install abf_explorer
```

## Launch GUI

```bash
abf_explorer
```

## Command line options

`-d` or `--startup-dir` specify path to a directory containing ABF files.

Use:

```python
abf_explorer -d path/to/abfs
```

## Sample data

Sample data (`abf`'s) can be downloaded from [this repository](https://github.com/nkicg6/ABF_Explorer/tree/master/data/abfs).


