Low-level typesafe HDF5 bindings
Haskell
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
src/Bindings
.gitignore
README.md
Setup.lhs
hdf5.cabal

README.md

HDF5 for Haskell

This is a low-level but typesafe Haskell interface to the HDF5 library. No pointers necessary.

In theory, it should not be possible to write code that corrupts or leaks memory using this package. That's the goal anyway. It has probably not been achieved. If you find any interface that doesn't live up to that goal, please open a ticket in the github issue tracker or email the maintainer.

Generally speaking, "type"-related exceptions should not occur either as long as the client code isn't monkeying about with unchecked hid_t casts, etc.

This interface does not aim to cover all of HDF5, at least not right now. If there's any missing functionality you need, let the maintainer know and we'll be happy to accept patches or (if we have the time) implement it.

Installation

First, you'll need to install the low level bindings - see that project's README for instructions. Once you've done that, this package can be installed using cabal:

git clone https://github.com/mokus0/hs-hdf5.git
cd hs-hdf5
cabal install

Usage

Step 1:

import Bindings.HDF5

Step 2:

Go nuts! (You probably will want to keep the HDF5 reference handy)

import Bindings.HDF5
import Control.Monad
import qualified Data.ByteString.Char8 as BS
import qualified Data.Vector.Storable as V
import qualified Data.Vector.Storable.Mutable as M
import System.Random

main = do
    -- first a silly "calculation", so we have something to write:
    densityVec <- M.replicate (10*10*10) (0.0 :: Float)
    replicateM_ 1000 $ do
        x <- randomRIO (0, 9)
        y <- randomRIO (0, 9)
        z <- randomRIO (0, 9)
        let -- location in the vector - writeDataset uses "row major" order.
            i = round x * 10 * 10
              + round y * 10
              + round z
        
        d <- M.read densityVec i
        M.write densityVec i (d + 1)
    densityVec <- V.freeze densityVec
    
    -- now write it to a file:
    file <- createFile (BS.pack "foo.h5") [Truncate] Nothing Nothing
    dataspace <- createSimpleDataspace [10,10,10]
    dataset <- createDataset file (BS.pack "density") nativeFloat dataspace
                    Nothing Nothing Nothing
    writeDataset dataset Nothing Nothing Nothing densityVec
    
    closeDataset dataset
    closeDataspace dataspace
    closeFile file

For more examples, take a look at the examples directory.