HDF5Kit

This is a Swift wrapper for the HDF5 file format. HDF5 is used in the scientific comunity for managing large volumes of data. The objective is to make it easy to read and write HDF5 files from Swift, including playgrounds.

Build and Test

macOS
- brew install hdf5
  - This does not appear to install a .pc file
- swift build -Xlinker -L/usr/local/lib/
- swift test -Xlinker -L/usr/local/lib/
- To generate the tests for Linux: swift test --generate-linuxmain -Xlinker -L/usr/local/lib/. This must be run with the Xcode-provided Swift at /usr/bin/swift. It does not work in Swift for Tensorflow or the Swift release build for macOS on swift.org.
Ubuntu
- sudo apt install libhdf5-dev
  - This puts a pkg-config file at /usr/lib/x86_64-linux-gnu/pkgconfig/hdf5.pc
- swift build -Xlinker -L/usr/lib/x86_64-linux-gnu/hdf5/serial
- swift test -Xlinker -L/usr/lib/x86_64-linux-gnu/hdf5/serial

Usage

Add to your project with:

.package(name: "HDF5Kit",
         url: "https://github.com/xanderdunn/HDF5Kit.git",
         .branch("master"))
.product(name: "HDF5Kit", package: "HDF5Kit"),

This example shows how to open an existing HDF5 file and write data to an existing dataset.

import HDF5Kit

// Initialize the data
let dataWidth = 6
let dataHeight = 4
var data = [Double](repeating: 0.0, count: dataHeight * dataWidth)
for r in 0..<dataHeight {
    for c in 0..<dataWidth {
        data[r * dataWidth + c] = Double(r * dataWidth + c + 1)
    }
}

// Open an existing file
let path = "file.h5"
guard let file = File.open(path, mode: .readWrite) else {
    fatalError("Failed to open \(path)")
}

// Open an existing dataset
let datasetName = "dset"
guard let dataset = file.openDoubleDataset(datasetName) else {
    fatalError("Failed to open dataset \(datasetName)")
}

// Write the data
try dataset.write(data)

Reading data is really easy with HDF5Kit:

// Open an existing file
let path = "file.h5"
guard let file = File.open(path, mode: .readWrite) else {
    fatalError("Failed to open \(path)")
}

// Open an existing dataset
let datasetName = "dset"
guard let dataset = file.openStringDataset(datasetName) else {
    fatalError("Failed to open dataset \(datasetName)")
}

let data = dataset[1...3, 2...5]

Supported types are: Double, Float, Int and String.