Skip to content

Commit 330b6e1

Browse files
committed
doc
1 parent 7824059 commit 330b6e1

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ call h5write('my.h5', '/x', x)
2020
call h5read('my.h5', '/y', y)
2121
```
2222

23-
For NetCDF4 see [nc4fortran](https://github.com/geospace-code/nc4fortran/).
23+
For NetCDF4 see
24+
[nc4fortran](https://github.com/geospace-code/nc4fortran/).
2425
h5fortran is designed for "serial" HDF5 read/write.
25-
We don't yet implement the interface for "parallel" HDF5.
26+
[h5fortran-mpi](https://github.com/geospace-code/h5fortran-mpi) is a Fortran interface for "parallel" HDF5.
2627

2728
h5fortran is designed for easy use using static or shared linking from your project via:
2829

@@ -36,7 +37,9 @@ Uses Fortran `submodule` for clean template structure.
3637
This easy-to-use, thin object-oriented modern Fortran library abstracts away the messy parts of HDF5 so that you can read / write various types/ranks of data with a single command.
3738
In distinction from other high-level HDF5 interfaces, h5fortran works to deduplicate code, using polymorphism wherever feasible and extensive test suite.
3839

39-
Polymorphic [API](./API.md) with read / write **dataset** types int32, int64, real32, real64, character (string) with rank scalar (0-D) through 7-D.
40+
Polymorphic
41+
[API](./API.md)
42+
with read / write **dataset** types int32, int64, real32, real64, character (string) with rank scalar (0-D) through 7-D.
4043
Variable-length datasets "H5S_UNLIMITED" can also be read.
4144

4245
HDF5 **attributes** are also supported for read/write types int32, int64, real32, real64, character (string) with rank scalar (0-D) through 7-D.
@@ -51,7 +54,7 @@ UTF8 characters are passed through on read and write using the Fortran default c
5154
* Zlib (deflate) compression / decompression -- h5fortran will work without Zlib, but will save/load uncompressed data only.
5255
* create HDF5 soft link variables--arbitrarily many soft-linked variable names can point to an actual variable, which need not yet exist.
5356

54-
Tested on systems with HDF5 1.8, 1.10 and 1.12 including:
57+
Tested on systems with HDF5 1.8, 1.10, 1.12, and 1.14 including:
5558

5659
* MacOS (homebrew)
5760
* Linux (Ubuntu, CentOS)
@@ -121,8 +124,6 @@ fpm install
121124
## Build HDF5 standalone
122125

123126
To build the HDF5 and ZLIB libraries, use the [scripts](./scripts/) folder.
124-
```
125-
126127

127128
## Usage
128129

@@ -171,6 +172,11 @@ The current h5fortran impementation (Fortran `select type` for H5Dwrite/H5Dread)
171172
HDF5 Fortran 2003
172173
[features](https://docs.hdfgroup.org/archive/support/HDF5/doc/fortran/NewFeatures_F2003.pdf)
173174

175+
## Alternatives
176+
177+
* [h5pp](https://github.com/DavidAce/h5pp) C++ HDF5 interface
178+
* [HighFive](https://github.com/BlueBrain/HighFive) C++ header-only HDF5 interface
179+
174180
## Acknowledgements
175181

176182
h5fortran was funded in part by NASA NNH19ZDA001N-HDEE grant 80NSSC20K0176.

0 commit comments

Comments
 (0)