Installation 🛠️

Requirements

Please ensure that the required libraries are installed.

• A C++17-compliant compiler
• CMake >= 3.15
• HDF5 >= 1.10
• Boost

Source

The source code for AqNWB is available online via the AqNWB GitHub repository. To checkout the latest developer version, clone the repository via:

git clone https://github.com/NeurodataWithoutBorders/aqnwb.git

Build

Here are the steps for building in release mode with a multi-configuration generator:

cmake -S . -B build
cmake --build build --config Release

Use the flag -DBUILD_SHARED_LIBS=ON to generate the shared library file.

Note

If you are using custom installations of HDF5 or BOOST that are not being detected automatically by cmake, you can specify HDF5_ROOT and BOOST_ROOT environment variables to point to install directories of HDF5 and BOOST respectively.

Install

Here is the command for installing the release mode artifacts with a multi-configuration generator:

cmake --install build --config Release