Photon-HDF5 / photon-hdf5

Photon-HDF5 Reference Documentation
http://photon-hdf5.readthedocs.io/
3 stars 3 forks source link

identity and provenance groups #9

Closed tritemio closed 9 years ago

tritemio commented 9 years ago

This issue is to discuss the identity and provenance groups.

identity

The root group /identity contains info about the Photon-HDF5 file at the moment of creation. It contains

    'filename'
        Photon-HDF5 file name at creation time.
    'full_filename'
        Photon-HDF5 full file name, including the folder
    'creation_time'
        Photon-HDF5 file creation time.
    'software'
        Software used to save the Photon-HDF5 file.
    'software_version'
        Software version used to save the Photon-HDF5 file.

provenance

The root group /provenance contains info about the original file that has been converted to Photon-HDF5. It contains:

    'provenance'
        Information about the original data file.
    'filename'
        Original file name.
    'full_filename'
        Original full file name, including the folder.'
    'creation_time'
        Original file creation time.
    'modification_time'
        Original file time of last modification.
    'author'
        The author of the measurement.
    'affiliation'
        Company or institution with which the author is affiliated.
tritemio commented 9 years ago

We could add a comment field in identity but I guess nobody will fill it or will contain irrelevant text most of the time.

Also, we already have /sample/sample_name that can serve a similar purpose, from the current document:

tritemio commented 9 years ago

Close as has been inglobated in #8