diff --git a/HDF5_Thumbnails.md b/HDF5_Thumbnails.md index 6a54a29..459d09a 100644 --- a/HDF5_Thumbnails.md +++ b/HDF5_Thumbnails.md @@ -1,6 +1,8 @@ # Overview -Most people are familiar with thumbnail images for JPEG images that are presented by a file browser. The same system can be used for HDF5 files to help users sort and locate their data files. HDF5 files +Most people are familiar with thumbnail images for JPEG images that are presented by a file browser. The same system can be used for HDF5 files to help users sort and locate their data files. HDF5 files can contain some header space (called a "user block" by the HDF Group) that can contain information that is not part of the dataspace managed by the HDF5 libraries. The [Extensible Metadata Platform](https://en.wikipedia.org/wiki/Extensible_Metadata_Platform) is a standardised XML-based system for inserting metadata into files. A script can be used by Pixelator to insert XMP metadata into the HDF5 data files, which can then be viewed in a standard file browser after installing the custom thumbnailer. + +Further information can be found in this [presentation from the 2019 HDF5 European Workshop](https://www.hdfgroup.org/wp-content/uploads/2019/09/Watts_XMP.pdf). # Pixelator @@ -15,4 +17,11 @@ python3 ../../PixelatorController/config/PolLux/scripts/insertXMP.py $filename 3. Edit your `settings.json` file (that is given as an argument to the Pixelator binary call) to ensure that the `endOfScanScript` parameter points to the script file above. -# File Browser \ No newline at end of file +# File Browser + +A custom thumbnailer is implemented by the [HDF5XMP](https://github.com/nexusformat/hdf5xmp) project, which can be installed on a computer to enable the native file browsers to access the XMP thumbnails embedded in the HDF5 files. +1. Download the [released precompiled thumbnailer binaries](https://github.com/nexusformat/hdf5xmp/releases) (expand the "assets") for your OS type. +2. Decompress the archive. +3. Follow the instructions in the `README.txt`. +4. (may need to restart the system) +5. Open a file browser and view some HDF5 files that have thumbnails embedded in them. \ No newline at end of file