Skip to content

HDF5 documentation#42

Open
The9Cat wants to merge 16 commits into
mainfrom
HDF5update
Open

HDF5 documentation#42
The9Cat wants to merge 16 commits into
mainfrom
HDF5update

Conversation

@The9Cat

@The9Cat The9Cat commented Jul 6, 2026

Copy link
Copy Markdown
Member

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 PSP format.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.rst page documenting the HDF5 snapshot structure and recommended reader behavior.
  • Updated topics/exp-phase-space.rst to 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.

Comment thread topics/output_hdf5.rst Outdated
Comment thread topics/output_hdf5.rst Outdated
Comment thread topics/exp-phase-space.rst Outdated
Comment thread topics/exp-phase-space.rst
Comment thread topics/exp-phase-space.rst Outdated
Comment thread topics/exp-phase-space.rst Outdated
Comment thread topics/exp-phase-space.rst Outdated
Comment thread topics/exp-phase-space.rst Outdated
Comment thread topics/exp-phase-space.rst
Comment thread conf.py
The9Cat and others added 13 commits July 6, 2026 13:39
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

Copy link
Copy Markdown
Member

This is great, thanks. My only question is when we merge this in, since the feature will linger in EXP/devel for some time, but we want the docs to be available somehow -- perhaps the solution is just to add banners saying this is only in 7.11?

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.

3 participants