biodream 0.2.5

Zero-copy, streaming-capable toolkit for reading and writing BIOPAC AcqKnowledge (.acq) files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Installation

## Library

Add biodream to your `Cargo.toml`:

```toml
[dependencies]
biodream = "0.2"
```

With optional features:

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

See [Feature Flags](./feature-flags.md) for the full list.

## CLI

Install the `biopac` binary:

```sh
cargo install biodream
```

Or build from source:

```sh
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](https://github.com/greysquirr3l/biodream/releases).

## MSRV

Rust **1.95.0** stable. Edition 2024.

## HDF5 system dependency

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

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

# macOS
brew install hdf5

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