Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HDF5 specification #156

Merged
merged 8 commits into from
Sep 29, 2023
Merged

HDF5 specification #156

merged 8 commits into from
Sep 29, 2023

Conversation

lang-m
Copy link
Member

@lang-m lang-m commented Sep 20, 2023

This notebooks describes and demonstrates the functionality of the extended HDF5 file format used in discretisedfield. The specification of Fields is intended to be general enough so that an extension of this document can also define a format for an HDF5 file that contains more data, e.g. a whole drive inside a single file, while re-using the specification (and implementation) of discretisedfield.

@lang-m
Copy link
Member Author

lang-m commented Sep 20, 2023

Tests will presumably fail until ubermag/discretisedfield#377 is merged.

@codecov-commenter
Copy link

codecov-commenter commented Sep 22, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (5454637) 36.36% compared to head (c3da257) 36.36%.
Report is 2 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #156   +/-   ##
=======================================
  Coverage   36.36%   36.36%           
=======================================
  Files           2        2           
  Lines          22       22           
=======================================
  Hits            8        8           
  Misses         14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@samjrholt samjrholt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good and informative, only a few things. One possible thing about the general structure was should talking about the attributes maybe be moved to after the tree? Then we explain basically everything in a single markdown cell rather than having a short break. Just an idea - I don't really mind :)

docs/hdf5-file-specification.ipynb Show resolved Hide resolved
docs/hdf5-file-specification.ipynb Outdated Show resolved Hide resolved
docs/hdf5-file-specification.ipynb Outdated Show resolved Hide resolved
docs/hdf5-file-specification.ipynb Outdated Show resolved Hide resolved
docs/hdf5-file-specification.ipynb Outdated Show resolved Hide resolved
docs/hdf5-file-specification.ipynb Outdated Show resolved Hide resolved
docs/hdf5-file-specification.ipynb Outdated Show resolved Hide resolved
@samjrholt samjrholt linked an issue Sep 22, 2023 that may be closed by this pull request
@lang-m lang-m merged commit 53c271d into master Sep 29, 2023
4 checks passed
@lang-m lang-m deleted the hdf5-specification branch September 29, 2023 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants