Uh oh!
There was an error while loading. Please reload this page.
HDF5 documentation - #42
Conversation
…er-component HDF5 initialization format
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.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
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>
michael-petersen
commented
Jul 7, 2026
This is great, thanks. My only question is when we merge this in, since the feature will linger in |
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.