Skip to content

Commit 4427197

Browse files
committed
Version bump. Add install instructions.
1 parent dce65b1 commit 4427197

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,18 @@
22

33
This program facilitates the analysis of auditory evoked responses (tested with auditory brainstem responses and compound action potentials). You can visualize the waveform series collected during a single experiment, and identify the threshold and extract the amplitude and latency of each of the individual peaks in the waveform.
44

5-
The default input/output format used by the program are designed to work with the in-house file format used by Eaton Peabody Laboratory. Refer to the parsers directory for documentation on how to adapt this program to your data format.
5+
The program works with the fillowing file formats:
6+
* ABR data generated by the Eaton Peabody Laboratories Cochlear Function Test Suite (EPL CFTS).
7+
* ABR data generated by [psiexperiment](https://github.com/psiexperiment/psiexperiment).
8+
* ABR data generated by the Intelligent Hearing Systems (IHS) text export.
9+
10+
Individal research groups have also adapted the program to work with their own file formats.
11+
12+
## Installing
13+
14+
The simplest way to get started is to download the [Anaconda Python Distribution](https://www.anaconda.com/distribution/). Once installed, you will have new programs available in your start menu. Open `Anaconda Prompt` and type `conda install -c bburan abr`. On windows, this will download the software and add a new shortcut to your start menu called `ABR analysis` which can be used to launch the program.
15+
16+
This program also works on Mac OS and Linux, but I do not have specific instructions for getting started on these platforms yet. Please give me a nudge if you need help with this and I can help you get started.
617

718
## Programs available
819

@@ -13,7 +24,7 @@ Both interfaces are accessed via the launcher. When you first open the launcher,
1324
* Your name (i.e., the "analyzer")
1425
* The file format. For many of you, you will pick the EPL CFTS unless you are using my software, [psiexperiment](https://github.com/bburan/psiexperiment) for data acquisition.
1526
* Which waves you want to analyze. If none are checked, we will assume that you only wish to mark threshold.
16-
* Filter settings to use. The original version of this program (distributed via the EPL website), filters waveforms using a 300 to 3000 Hz bandpass butterworth filter. However, many
27+
* Filter settings to use. The original version of this program (distributed via the EPL website), filters waveforms using a 300 to 3000 Hz bandpass butterworth filter.
1728

1829
## Processing
1930

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
setup(
2929
name='ABR',
30-
version='0.0.2',
30+
version='0.0.3',
3131
author='Brad Buran',
3232
author_email='[email protected]',
3333
description='ABR wave analyzer',

0 commit comments

Comments
 (0)