Skip to content

Commit 77c13b7

Browse files
authored
Update yt documentation (quokka-astro#1832)
### Description Update yt usage guide on the documentation page. ### Related issues None. ### Checklist _Before this pull request can be reviewed, all of these tasks should be completed. Denote completed tasks with an `x` inside the square brackets `[ ]` in the Markdown source below:_ - [ ] I have added a description (see above). - [ ] I have added a link to any related issues (if applicable; see above). - [ ] I have read the [Contributing Guide](https://github.com/quokka-astro/quokka/blob/development/CONTRIBUTING.md). - [ ] I have added tests for any new physics that this PR adds to the code. - [ ] *(For quokka-astro org members)* I have manually triggered the GPU tests with the magic comment `/azp run`.
1 parent c2aec27 commit 77c13b7

2 files changed

Lines changed: 8 additions & 9 deletions

File tree

docs/markdown/postprocessing.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,24 @@ Other tools:
3434

3535
## yt
3636

37-
> **Warning**
38-
>
39-
> There are [known bugs](https://github.com/yt-project/yt/issues/3889) that affect Quokka outputs. PlotfileTools (see above) can be used instead for axis-aligned slice plots.
40-
>
37+
yt can load Quokka AMReX plotfiles through its Quokka frontend, which is now available in the main [yt](https://github.com/yt-project/yt) repository. Until a released yt version includes the frontend, install yt from the main branch with the optional Quokka dependencies:
38+
39+
pip install "yt[quokka] @ git+https://github.com/yt-project/yt.git"
40+
41+
After installation, load a plotfile with `yt.load("plt00000")` or point yt to any other Quokka plotfile directory. The upstream Quokka frontend documentation is available in the [yt documentation source](https://github.com/yt-project/yt/blob/main/doc/source/examining/loading_data.rst#quokka-data), and a tutorial notebook is available at [README.ipynb](https://github.com/Rongjun-ANU/README-of-yt-frontend-for-QUOKKA/blob/main/README.ipynb).
4142

4243
> **Tip**
4344
>
4445
> One of the most useful things to do is to convert the data into a uniform-resolution NumPy array with the [covering_grid](https://yt-project.org/doc/examining/low_level_inspection.html#examining-grid-data-in-a-fixed-resolution-array) function.
4546
>
4647
47-
We have a fork of YT that includes a customized Quokka frontend: [https://github.com/chongchonghe/yt](https://github.com/chongchonghe/yt). To install it, run `pip install "yt[quokka] @ git+https://github.com/chongchonghe/yt.git"`. A comprehensive documentation is available at [this link](https://github.com/chongchonghe/yt/blob/Rongjun-ANUquokka-frontend/doc/source/examining/loading_data.rst#quokka-data), and a Jupyter Notebook with tutorials is available at [README.ipynb](https://github.com/Rongjun-ANU/README-of-yt-frontend-for-QUOKKA/blob/main/README.ipynb).
48-
4948
### quick_plot script for batch processing
5049

51-
The `quick_plot` script in `scripts/python/` is a convenient tool for visualizing Quokka outputs. It is a wrapper around YT for batch processing snapshots and generating slice or projection plots. The script has detailed documentation in the code itself, accessible at the top of the file and also by running `quick_plot -h`.
50+
The `quick_plot` script in `scripts/python/` wraps yt for batch visualization of Quokka outputs. It can process multiple snapshots and generate slice or projection plots. For usage details, see the documentation at the top of the script or run `quick_plot -h`.
5251

5352
### yt-studio for web-based visualization
5453

55-
[yt-studio](https://github.com/chongchonghe/yt-studio) is a visualization tool for QUOKKA simulation data that provides both a web-based interface and Python API. Install it with `pip install git+https://github.com/chongchonghe/yt-studio.git`, then start the web interface with `yt-studio` and open http://localhost:5173 in your browser. The tool supports slice plots, projection plots, volume rendering, multiple colormaps, and high-resolution export, with optional particle overlay and AMR grid annotations. For programmatic use, the Python API offers `QuokkaPlotter` class methods like `slice()` and `project()` for generating publication-quality visualizations.
54+
[yt-studio](https://github.com/chongchonghe/yt-studio) provides a web interface and Python API for visualizing Quokka simulation data. Install it with `pip install git+https://github.com/chongchonghe/yt-studio.git`, then start the web interface with `yt-studio` and open http://localhost:5173 in your browser. It supports slice plots, projection plots, volume rendering, multiple colormaps, high-resolution export, optional particle overlays, and AMR grid annotations. For scripts and notebooks, use the `QuokkaPlotter` methods such as `slice()` and `project()`.
5655

5756
![yt-studio-screenshot](media/yt-studio-screenshot.jpg)
5857

scripts/python/quick_plot

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ KEY FUNCTIONS:
6868
6969
TECHNICAL DETAILS:
7070
==================
71-
- Requires yt installed from: https://github.com/chongchonghe/yt
71+
- Requires yt installed via: `pip install "yt[quokka] @ git+https://github.com/yt-project/yt.git"`
7272
- Supports AMReX/BoxLib simulation formats
7373
- Handles derived field creation for temperature and number density calculations, in which case mu = 1 m_p and gamma = 5/3 are assumed. The mean molecular weight can be specified with '--mean_molecular_weight' in atomic mass units.
7474
- Automatically filters out .old. directories

0 commit comments

Comments
 (0)