Installation 🛠️

Requirements

Please ensure that the required libraries are installed.

• A C++17-compliant compiler
• CMake >= 3.15
• HDF5 >= 1.10
• libcurl (optional, required for remfile support)

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

To enable reading remote files via the remfile virtual file driver, add the -DAQNWB_USE_REMFILE=ON option during configuration.

AqNWB first looks for an installed remfile-cpp package. If it is not found, CMake downloads and builds a pinned remfile-cpp release during configuration. Install remfile-cpp first to use that installation and skip the download. When CMake downloads remfile-cpp, installing AqNWB also installs remfile-cpp into the same installation prefix.

Note that ROS3 support is automatically enabled if your HDF5 installation was built with ROS3 support (i.e., H5_HAVE_ROS3_VFD is defined).

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

Note

If you are using a custom installation of HDF5 that is not being detected automatically by CMake, you can specify the HDF5_ROOT environment variable to point to the install directory of HDF5.

Install

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

cmake --install build --config Release