Skip to main content

Install

Command-line tool​

cargo install openkspace-cli
openkspace --help

This installs an openkspace binary on your PATH.

Rust library​

Add the appropriate crate to your Cargo.toml:

[dependencies]
openkspace-io    = "0.2"   # ISMRMRD HDF5 reader
openkspace-recon = "0.2"   # calibration + recon strategies

MSRV: Rust 1.87.

System dependencies​

OpenKSpace reads HDF5 files via the hdf5-metno crate. On Linux:

sudo apt-get install libhdf5-dev

On macOS:

brew install hdf5

On Windows, the hdf5-metno build script will download a pre-built HDF5 binary automatically.

From source​

git clone https://github.com/Sigilweaver/OpenKSpace
cd OpenKSpace
cargo build --release
./target/release/openkspace --help