h5read, h5write easy I/O

Author: scivision

CMakeLists.txt

@@ -4,7 +4,7 @@ if(NOT CMAKE_BUILD_TYPE)
 endif()
 project(hdf5iface
   LANGUAGES Fortran
-  VERSION 2.4.4
+  VERSION 2.5.0
   DESCRIPTION "thin, light, easy HDF5 Fortran interface"
   HOMEPAGE_URL https://github.com/scivision/h5fortran)
 enable_testing()

README.md

@@ -5,9 +5,20 @@
 [![Actions Status](https://github.com/scivision/h5fortran/workflows/ci_linux/badge.svg)](https://github.com/scivision/h5fortran/actions)
 [![Actions Status](https://github.com/scivision/h5fortran/workflows/ci_mac/badge.svg)](https://github.com/scivision/h5fortran/actions)
 
-Straightforward single-module access to HDF5.
-For NetCDF4 see [nc4fortran](https://github.com/scivision/nc4fortran/).
-Designed for easy use as a Meson "subproject" or CMake "ExternalProject / FetchContent" using **static** or **shared** linking.
+Simple, robust, thin HDF5 polymorphic read/write interface.
+Reading or writing {real64,real32,int64,int32} from scalar to 7d is as simple as
+
+```fortran
+use h5fortran
+
+call h5save('foo.h5', '/x', x)
+
+call h5read('bar.h5', '/y', y)
+```
+
+* For NetCDF4 see [nc4fortran](https://github.com/scivision/nc4fortran/).
+* Designed for easy use as a Meson "subproject" or CMake "ExternalProject / FetchContent" using **static** or **shared** linking.
+
 Uses Fortran 2008 `submodule` for clean template structure.
 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.
 In distinction from other high-level HDF5 interfaces, h5fortran works to deduplicate code, using polymorphism wherever feasible and extensive test suite.

meson.build

@@ -1,6 +1,6 @@
 project('h5fortran', 'fortran',
   meson_version : '>=0.52.0',
-  version : '2.4.4',
+  version : '2.5.0',
   default_options : ['default_library=static', 'buildtype=release', 'warning_level=3'])
 
 subdir('meson')

src/hdf5_interface.f90

@@ -9,6 +9,9 @@ module h5fortran
 use string_utils, only : toLower, strip_trailing_null, truncate_string_null
 
 implicit none
+private
+public :: hdf5_file, toLower, hsize_t, strip_trailing_null, truncate_string_null, check, h5write, h5read
+
 
 !> main type
 type :: hdf5_file
@@ -47,10 +50,115 @@ module h5fortran
 
 end type hdf5_file
 
+interface h5write
+  procedure lt0write, lt1write, lt2write, lt3write, lt4write, lt5write, lt6write, lt7write
+end interface h5write
+
+interface h5read
+  procedure lt0read, lt1read, lt2read, lt3read, lt4read, lt5read, lt6read, lt7read
+end interface h5read
+
 
 !> Submodules
 interface
 
+module subroutine lt0write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value
+integer, intent(out), optional :: ierr
+end subroutine lt0write
+
+module subroutine lt1write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value(:)
+integer, intent(out), optional :: ierr
+end subroutine lt1write
+
+module subroutine lt2write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value(:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt2write
+
+module subroutine lt3write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value(:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt3write
+
+module subroutine lt4write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value(:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt4write
+
+module subroutine lt5write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value(:,:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt5write
+
+module subroutine lt6write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value(:,:,:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt6write
+
+module subroutine lt7write(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(in) :: value(:,:,:,:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt7write
+
+module subroutine lt0read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value
+integer, intent(out), optional :: ierr
+end subroutine lt0read
+
+module subroutine lt1read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value(:)
+integer, intent(out), optional :: ierr
+end subroutine lt1read
+
+module subroutine lt2read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value(:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt2read
+
+module subroutine lt3read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value(:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt3read
+
+module subroutine lt4read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value(:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt4read
+
+module subroutine lt5read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value(:,:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt5read
+
+module subroutine lt6read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value(:,:,:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt6read
+
+module subroutine lt7read(filename, dname, value, ierr)
+character(*), intent(in) :: filename, dname
+class(*), intent(out) :: value(:,:,:,:,:,:,:)
+integer, intent(out), optional :: ierr
+end subroutine lt7read
+
+
 module subroutine hdf_setup_read(self, dname, dims, ierr)
 class(hdf5_file), intent(in) :: self
 character(*), intent(in) :: dname
@@ -240,12 +348,6 @@ end subroutine writeattr
 
 end interface
 
-integer, parameter :: ENOENT = 2, EIO = 5
-
-private
-public :: hdf5_file, toLower, hsize_t, strip_trailing_null, truncate_string_null, check
-
-
 contains
 
 
@@ -310,17 +412,19 @@ subroutine hdf_initialize(self,filename,ierr, status,action,comp_lvl,chunk_size,
         inquire(file=filename, exist=exists)
         if (.not.exists) then
           write(stderr,*) 'ERROR: ' // filename // ' does not exist.'
-          ierr = ENOENT
+          ierr = -1
+          return
         endif
         call h5fopen_f(filename,H5F_ACC_RDONLY_F,self%lid,ierr)
       case('write','readwrite','w','rw', 'r+', 'append', 'a')
         inquire(file=filename, exist=exists)
         if(lstatus == 'unknown' .and. .not.exists) then
-          call h5fopen_f(filename, H5F_ACC_TRUNC_F, self%lid,ierr)
+          call h5fcreate_f(filename, H5F_ACC_TRUNC_F, self%lid, ierr)
+          if (check(ierr, 'ERROR: ' // filename // ' could not be created')) return
         else
-          call h5fopen_f(filename, H5F_ACC_RDWR_F, self%lid,ierr)
+          call h5fopen_f(filename, H5F_ACC_RDWR_F, self%lid, ierr)
+          if (check(ierr, 'ERROR: ' // filename // ' could not be opened in read/write')) return
         endif
-        if (check(ierr, 'ERROR: ' // filename // ' could not be opened')) return
       case default
         write(stderr,*) 'Unsupported action -> ' // laction
         ierr = 128