forked from kramergroup/openImpala
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Labels: documentation, visualization, phase:0-polish
Priority: High (Quick Win)
Description
OpenImpala solves on multi-billion voxel domains, which makes loading the entire output into local RAM for visualization impossible for most users. Because OpenImpala uses the AMReX backend, our output plotfiles are natively supported by the yt project, a Python package built explicitly for out-of-core astrophysical AMR data.
We need to document how users can use yt directly in their Jupyter notebooks to explore massive OpenImpala datasets without triggering Out-Of-Memory (OOM) errors.
Acceptance Criteria
- Add a new tutorial:
notebooks/visualization_yt.ipynb. - Demonstrate how to load an OpenImpala AMReX plotfile using
yt.load(). - Show how to generate a 2D
yt.SlicePlotof the computed tortuosity flux field. - Show how to generate a 1D
yt.ProfilePlot(e.g., average flux along the Z-axis). - Add
ytto the[project.optional-dependencies.docs]section ofpyproject.tomlso it builds correctly in Sphinx.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels