open-ephys-audio
This project contains scripts and python libraries used by the Meliza Lab to run auditory neurophysiology experiments on the open-ephys GUI. The functionality was later expanded to support other data acquisition systems, but the name was kept the same.
Stimuli are read from monaural sound files (e.g. wave format) and played through a sound card on the first (typically left) channel. A synchronization click is added at the start of the stimulus on the second channel. Before starting playback, the script notifies open-ephys over its ZMQ channel to begin recording, and tells it to stop after playback has ended. A single long recording is generated, but can be split up later based on the synchronization clicks.
If the sound card has more than two output channels, pulses can also be emitted on the third channel a user-defined amount of time before the stimulus onset.
Note that the synchronization clicks will be audio line-level, and that many sound cards have a highpass filter that will cause a square pulse to slowly decay back to baseline. If necessary, a Schmitt trigger can be used to transform the sync and trigger signals into TTL-level square pulses.
Installation
The recommended way to install open-ephys-audio is using pipx, which will create a dedicated virtual environment for the script and expose the oeaudio-present command on your path. Run pipx install open-ephys-audio and you should be good to go.
Example
oeaudio-present --buffer-size=100 -a tcp://localhost:5556 -d /home/melizalab/open-ephys/ -k animal=P168 -k experimenter=smm3rc -k experiment=chorus -k hemisphere=R -k pen=2 -k site=2 -k x=-1175 -k y=-861 -k z=-2400 -S 1022 stimuli/msyn-noise-v2/*.wavThis command will play all the wave files in the stimuli/msyn-noise-v2 directory. All of the -k arguments will be stored in the open-ephys recording as metadata. If you don’t want to record (e.g., while searching for units), you can run something like this:
oeaudio-present --loop --gap 5 ../songs/*.wav1 maintainer
Metadata
1 maintainer
Release files for open-ephys-audio 0.1.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| open_ephys_audio-0.1.9.tar.gz | 50.2 kB | With provenance | Details for open_ephys_audio-0.1.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| open_ephys_audio-0.1.9-py3-none-any.whl | Python 3 | none | any | Details for open_ephys_audio-0.1.9-py3-none-any.whl |
Total release size: 59.5 kB
Release files / open_ephys_audio-0.1.9.tar.gz
| Download URL | open_ephys_audio-0.1.9.tar.gz |
|---|---|
| Size | 50.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
97603aaa978ef66d9c26113dcd1bc59bb2bac965ef791b93aa7ea9fc217ba2e6
|
|
BLAKE2b-256 checksum How to use checksums |
d26544a1e33c2608378f8e5d35bcc2f9fb34b32aa96e7a1ff3a02952bbc0c499
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.
Transparency logRelease files / open_ephys_audio-0.1.9-py3-none-any.whl
| Download URL | open_ephys_audio-0.1.9-py3-none-any.whl |
|---|---|
| Size | 9.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58b5c197ad2f693533e4c4cde608aab1b0d533ec4edd7adc37774ae34d7fc7b5
|
|
BLAKE2b-256 checksum How to use checksums |
f7c45de6fbc5fefa113790ce843912f1a443bd7627508d91eb5adad02274040d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.
Transparency logSecurity for open-ephys-audio 0.1.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for open_ephys_audio-0.1.9.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
