directory -> group/path

nilsbecker commented 9 years ago

great to see that hdf5 support is finally coming to ocaml!

on cursory reading of the highlevel api and docs i often see the term 'directory'. while this is of course intuitive, the standard terminology is path if it's the string or 'group' (and/or 'dataset') if it's the object i believe.

https://www.hdfgroup.org/HDF5/doc/Glossary.html#Glossary-Group

i know hdf5 via h5py which is a joy to use. this is of course based on numpy and heavily uses overloading of slicing syntax, which is probably not a good match for ocaml. but there might be other aspects where it could serve as inspiration for the api.

https://github.com/h5py/h5py/tree/master/h5py/_hl

some ideas for the highlevel interface (may be nonsense and/or already implemented, sorry if so.)

i would have expected a single file creation function with some variant argument for the file mode. but i guess that's taste?
would it be good to provide a 'with file' construct/function which would work like a context manager in python?
fold/iter/map functions over hdf5 groups? (this may be nonsense since the links in an hdf5 file can be duplicate and circular as i just found out)
hdf5 capabilities depend on the format version a lot. highlevel verification of version requirements for opened files?

disclaimer: have not actually used, only looked at the .mli's

vbrankov commented 8 years ago

Thanks for the feedback. I've replaced "directory" with "group".

struktured commented 7 years ago

@vbrankov I still see the term directory in the high level api.

vbrankov commented 7 years ago

I grepped the code for "irectory" and cannot find it. Where do you see it?

struktured commented 7 years ago

See https://github.com/vbrankov/hdf5-ocaml/blob/master/lib/caml/h5.cppo.ml#L66 (with_dir and open_dir).

vbrankov commented 7 years ago

Fixed.

vbrankov / hdf5-ocaml

directory -> group/path #1