https://github.com/hdfgroup/vol-tutorial
Tutorial HDF5 VOL connector
https://github.com/hdfgroup/vol-tutorial
Last synced: 10 months ago
JSON representation
Tutorial HDF5 VOL connector
- Host: GitHub
- URL: https://github.com/hdfgroup/vol-tutorial
- Owner: HDFGroup
- License: other
- Created: 2021-11-04T03:07:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-28T17:21:04.000Z (over 4 years ago)
- Last Synced: 2025-08-01T16:36:22.265Z (11 months ago)
- Language: C
- Size: 855 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
- Authors: AUTHORS
Awesome Lists containing this project
README
# HDF5 Tutorial VOL Connector
This is an HDF5 virtual object layer (VOL) connector designed to work with the VOL tutorial. It maps the HDF5 API to file system objects like directories and flat text files.
NOTE: This connector targets HDF5 1.13.0. The VOL API in HDF5 1.12.x is no longer supported for VOL connector development.
## Getting started
You will need a few things to build the code in this repository:
* HDF5 1.13.0 or later
* CMake (3.9 or later) or the Autotools (autoconf 2.69 or later and matching automake, etc.)
* Currently only supports UNIX-like environments since it uses POSIX API calls (i.e., no Windows yet)
### Autotools Builds
1) The first thing you need to do is run the autogen.sh script located in the source root. This will run the autotools and generate the build files.
2) Next, switch to your build directory and run configure. You might need to specify the path to a VOL-enabled HDF5 (version 1.13.0 or later) using the --with-hdf5 option. Note that --with-hdf5 needs you to specify the path to the (p)h5cc file (including h5cc).
3) Once configured, you should be able to run make to build the template. Running 'make check' will build the test program and run the test script.
### CMake Builds
1) Run ccmake or the CMake GUI and point it at a VOL-enabled HDF5 installation. You may need to switch to see HDF5\_DIR, which you'll need to set to the share/cmake directory of your install. Configure and generate.
2) Build the software using 'make', etc.
3) Run the test program using 'make test', 'ctest .', etc.
## Building each step of the tutorial
Each section of the tutorial is implemented in its own branch. Switch to the branch using 'git checkout ', configure, build, and test.
The main branch of the repository is the full tutorial VOL connector after all steps have been completed.
In order, the branches are:
1. boilerplate
2. file\_operations
3. group\_operations
4. dataset\_operations
There is just one simple test program that exercises the tutorial VOL. The vol-test repository functionality is not used to test this simple connector.