Installation

Library

Add biodream to your Cargo.toml:

[dependencies]
biodream = "0.2"

With optional features:

[dependencies]
biodream = { version = "0.2", features = ["arrow", "parquet", "write"] }

See Feature Flags for the full list.

CLI

Install the biopac binary:

cargo install biodream

Or build from source:

git clone https://github.com/greysquirr3l/biodream
cd biodream
cargo build --release --features "read,write,csv,arrow,parquet"
# binary is at target/release/biopac

Pre-built binaries

Pre-built binaries for Linux x86-64, macOS ARM, macOS x86, and Windows x86-64 are attached to each GitHub Release.

MSRV

Rust 1.95.0 stable. Edition 2024.

HDF5 system dependency

The hdf5 feature requires libhdf5-dev to be installed on the system:

# Ubuntu / Debian
sudo apt-get install libhdf5-dev

# macOS
brew install hdf5

# Windows: download from https://www.hdfgroup.org/downloads/hdf5/

If the HDF5 library is installed in a non-default location, set one of:

# Preferred: point directly at the HDF5 installation root
export HDF5_DIR="/path/to/hdf5"

# Alternative: make pkg-config aware of HDF5
export PKG_CONFIG_PATH="/path/to/hdf5/lib/pkgconfig:${PKG_CONFIG_PATH}"

Quick verification:

pkg-config --modversion hdf5 || echo "hdf5 not found via pkg-config"