Skip to content

StoneRidgeTechnology/encore.hdf5.binding

Repository files navigation

module::encore.hdf5.binding status stability-experimental

This is binding for HDF5.

About the fork

This is fork, which is created to provide prebuild versions and fix issues of the original implementation.

Support

Node versions:

  • v14
  • v13
  • v12
  • v10

HDF5 versions:

  • v1.10.x
  • v1.8.x

How to add to your project

npm add encore.hdf5.binding@stable

This installation method assumes that you have HDF5 library installed at default path.

Default path to HDF5 library

The module expects that HDF5 library is installed at:

Platform Path
Linux /usr/local
Windows C:/Software/hdf5
Mac /usr/local

How to provide custom path to HDF5 library

If your HDF5 library installation is not located on default path you can set the path with a switch on this project as well as dependent projects:

On Linux:

npm add encore.hdf5.binding@stable --hdf5_home_linux=<your native hdf path>

On Mac:

npm add encore.hdf5.binding@stable --hdf5_home_mac=<your native hdf path>

On Windows:

npm add encore.hdf5.binding@stable --hdf5_home_win=<your native hdf path>

How to install HDF5 library

Installation instructions for HDF5 library can be found here

Prerequisites

Note: If node-gyp isn't installed

npm install -g node-gyp

Try out

var path = require( 'path' );
var hdf5 = require( 'encore.hdf5.binding' ).hdf5;
var Access = require( 'encore.hdf5.binding' ).globals.Access;

var file = new hdf5.File( path.join( __dirname, './File.h5' ), Access.ACC_RDONLY );
var members = file.getMemberNames();

console.log( members );

/*
log:
[ 'group1' ]
*/

file.close();

Source code