Skip to main content

Helper tools to handle H5 files

Project description

H5CROSS

This package provides basic utilities allowing the comparison of hdf5 type files. This includes the computation of standard statistics on data arrays such as the mean, min, max, median and standard deviation. An interactive mode is enabled through the use of nobvisual (https://pypi.org/project/nobvisual/). Scatter plot comparative capability is enabled through seaborn and matplotlib.

Installation

Installation using Pypi:

> pip install h5cross

Usage

Use the CLI for a basic terminal usage.

   ---------------    H5CROSS  --------------------

  You are now using the Command line interface of h5cross a Python3 helper
  to explore and compare hdf5 files, created at CERFACS
  (https://cerfacs.fr).

  This is a python package currently installed in your python environement.

Options:
  --help  Show this message and exit.

Commands:
  convert   Conversion to hdf5 of certain file formats.
  diff      Compare the content of two hdf5 files and view interactively...
  dump      Write the content of an hdf5 file into a YAML file.
  scatter   Scatter plot comparison of two hdf5 files.
  stats     Compute statistics of arrays from hdf5 file.
  tree      Print the content of an hdf5 file in terminal.
  view      Show the content of an hdf5 file interactively with nobvisual.

Possibilities

Console file structure visualization

The command >h5cross tree prints the structure of an HDF5 file in the console.

tree_output

Statistical information of file

The command >h5cross stats computes the mean, min, max, median and standard deviation of every data set for a given HDF5 file. It is then output into the console (can be optionally deactivated). The result can be optionally saved in a YAML format (.yml). A pretty table output is set to default and can be optionally be deactivated in which case a tree output is given. In a pretty table, the full nested path is shown but can be deactivated.

stats_pretty_output

stats_pretty_output

stats_tree_output

Save file structure

The command >h5cross dump outputs the structure of an HDF5 file in a YAML format (.yml).

View file structure

The command >h5cross view allows an interactive view of the structure of an HDF5 file. It relies on the nobvisual package designed for the visualisation of nested objects. A temporary .yml file is generated to allow the interactive use.

view

Compare file structures

The command >h5cross diff compares the structure of two HDF5 files. Similarily to >h5cross view it relies on the nobvisual package. It is optionally possible to add the statistical information of both files in this representation.

diff

Compare field data

The command >h5cross scatter allows the scatter plot comparison of selected data fields from two HDF5 files. If the data array lengths of each file differ an histogram representation will be given instead. A minimum requirement is the matplotlib package. By default it uses the seaborn package if available but this setting can be optionally deactivated. The density colormap requires the scipy package, if not available a single color will be used.

seaborn

plt

hist

Converting file types to HDF5 file

It is possible to convert certain file formats to HDF5 with >h5cross convert . Currently supported: nek5000, pvtu, vtu, vtk.

Acknowledgement

h5cross is a service created in the EXCELLERAT Center Of Excellence and is continued as part of the COEC Center Of Excellence. Both projects are funded by the European community. logo logo

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

h5cross-0.2.7.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

h5cross-0.2.7-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file h5cross-0.2.7.tar.gz.

File metadata

  • Download URL: h5cross-0.2.7.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for h5cross-0.2.7.tar.gz
Algorithm Hash digest
SHA256 b0cad4e47a8b575adb4dca2f14c5079b8d4a3605624289a8871c20a62b7866da
MD5 39bebe8885c7dce7569c656bfa8c4880
BLAKE2b-256 3c9e028744d9609c02f2ad6f44742f5589cefbc2474268923f97dfa510f382fc

See more details on using hashes here.

File details

Details for the file h5cross-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: h5cross-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for h5cross-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 793be599ab16657933371ac8f132e0aeed1f3ea9e5213a4210c56a9ca33b16c6
MD5 848c272eb84b71bf6b3a3a4b42e72499
BLAKE2b-256 8dd51d58712ad4a48bef514be746eed4be0d0dbfbd16b2eb9404aeb009478150

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page