medengineer / hdf5plugins

Open Ephys HDF5 plugins

This reposiory contains the following first party plugins developed by Open Ephys that make use of the HDF5 library:

• KWIKFormat: A plugin to record to and read from files based on the KWIK specification
• NWBFormat: A format to record to files based on the Neurodata Without Borders 1.0 specification
• OpenEphysHDF5Lib: A common library for all formats that write HDF5 files

Installation

Installing the HDF5 library

The plugin requires a specific version of the HDF5 library (≥1.8.12 and <1.8.21) For windows, the required files are already included for the plugin We have detailed instructions on our wiki on how to install the required HDF5 version for Linux and macOS.

Building the plugins

Building the plugins requires CMake. Detailed instructions on how to build open ephys plugins with CMake can be found in our wiki. We highly recommend building all three projects simultaneously using the configuration provided in the top-level Build folder, instead of the individual plugins. Building the plugins individually will need manual tweaking for them to find the OpenEphysHDF5 common library.