fix documentation of HDF5 backend options#65
Open
olivhoenen wants to merge 1 commit into
Open
Conversation
prasad-sawantdesai
requested changes
Jun 11, 2026
prasad-sawantdesai
left a comment
prasad-sawantdesai
left a comment
Collaborator
There was a problem hiding this comment.
Should we also update docs/source/user_guide/configuration.rst
https://github.com/iterorganization/IMAS-Core/blob/develop/docs/source/user_guide/configuration.rst?plain=1#L100
(default is 100)?
|
|
||
| ``hdf5_read_buffering`` | ||
| During a ``get`` operation, field data read from HDF5 is buffered in memory | ||
| before being returned to the caller. |
Collaborator
There was a problem hiding this comment.
hdf5_read_buffering
During a get operation, supported 0D and 1D field data read from HDF5 is
buffered in memory before being returned to the caller. Slice and time range
reads, as well as fields with higher dimensionality, are read directly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found some inconsistencies between the doc and the code in https://github.com/iterorganization/IMAS-Core/blob/develop/src/hdf5/hdf5_utils.cpp#L732
Note that open_read_only was described be never added to the code (cf. https://git.iter.org/projects/IMAS/repos/al-core/pull-requests/56/overview). Maybe these commits can be added in the new repo?