HDF5 documentation#42
Open
The9Cat wants to merge 16 commits into
Open
Conversation
added 2 commits
July 6, 2026 10:54
…er-component HDF5 initialization format
6 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds and updates documentation to describe EXP’s HDF5 phase-space output format and related initialization/utility workflows, alongside a small Sphinx configuration tweak and tutorial notebook refresh.
Changes:
- Added a new
topics/output_hdf5.rstpage documenting the HDF5 snapshot structure and recommended reader behavior. - Updated
topics/exp-phase-space.rstto describe HDF5 initialization schema and tools, and to link to the new HDF5 output docs. - Updated Sphinx config and a tutorial notebook to reflect current docs/build layout and pyEXP usage/output.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| topics/output_hdf5.rst | New documentation page describing the EXP HDF5 snapshot schema and reader guidance. |
| topics/exp-phase-space.rst | Expanded phase-space docs with HDF5 initialization schema and updated utilities/recommendations. |
| intro/Tutorials/Part1-Coefficients.ipynb | Tutorial notebook updates (version info output, units writeout, output text changes). |
| conf.py | Doc build metadata bump and expanded exclude_patterns (now excluding exp_repo/**). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Member
|
This is great, thanks. My only question is when we merge this in, since the feature will linger in |
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
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.
What
While it was fresh, I thought it best to document the recent HDF5 initialization changes implemented in EXP-code/EXP#224. Seemed like a good time to provide a full documentation for the EXP HDF5 file format intended to replace the older native
PSPformat.