Skip to content

Commit 0c17f81

Browse files
authored
📄 (docs) improve visual layouts (#441)
1 parent 71e9eec commit 0c17f81

8 files changed

Lines changed: 57 additions & 29 deletions

File tree

docs/source/concepts/check.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,10 @@ Messages are reported with a severity, a stable code, a location and a short
5555
description. Errors return exit code `1`; warnings return exit code `2` only in
5656
strict mode.
5757

58-
## Notes
58+
## Validation notes
5959

60-
- For CGNS datasets, only `infos.yaml` and `data/` are required at the root.
61-
- For other backends, metadata files and `constants/` are checked as well.
62-
- Without `--problem-definition`, all discovered problem definitions are checked.
63-
- In JSON mode, progress bars are disabled to keep the output parseable.
60+
!!! note "Dataset validation behavior"
61+
- For CGNS datasets, only `infos.yaml` and `data/` are required at the root.
62+
- For other backends, metadata files and `constants/` are checked as well.
63+
- Without `--problem-definition`, all discovered problem definitions are checked.
64+
- In JSON mode, progress bars are disabled to keep the output parseable.

docs/source/concepts/viewer.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,14 @@ The viewer can open data from two places:
154154

155155
When streaming is active, a `streaming` chip appears in the toolbar.
156156

157-
## Tips
158-
159-
- If the 3D view is empty, first select a **Base** in step 4.
160-
- If the field dropdown is empty, load fields with **Load all** or by selecting
161-
features in step 5.
162-
- If the viewer feels slow on a large dataset, load only one base and a small
163-
number of fields.
164-
- The message at the bottom of the side panel reports the latest action or
165-
error.
157+
158+
## Troubleshooting
159+
160+
!!! tip "Viewer tips"
161+
- If the 3D view is empty, first select a **Base** in step 4.
162+
- If the field dropdown is empty, load fields with **Load all** or by selecting
163+
features in step 5.
164+
- If the viewer feels slow on a large dataset, load only one base and a small
165+
number of fields.
166+
- The message at the bottom of the side panel reports the latest action or
167+
error.

docs/source/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,10 @@ Before opening a PR that modifies docs or public APIs, run a quick consistency p
190190

191191
1. **Build docs locally**
192192

193-
```bash
194-
cd docs
195-
bash generate_doc.sh
196-
```
193+
```bash
194+
cd docs
195+
bash generate_doc.sh
196+
```
197197

198198
2. **Validate API references**
199199

docs/source/physarena.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# PhysArena
2+
3+
[PhysArena](https://huggingface.co/PhysArena) is a Hugging Face organization page
4+
dedicated to resources for machine learning on physics simulations.
5+
6+
It provides standardized benchmarks with fixed evaluation protocols, metrics, and splits to enable fair and reproducible comparison of models on physical problems.
7+
8+
All datasets are distributed in the PLAID format, ensuring a uniform, structured representation across benchmarks and seamless interoperability with the PLAID ecosystem.
9+
10+
<p align="center">
11+
<a href="https://huggingface.co/PhysArena">
12+
<img src="https://huggingface.co/datasets/huggingface/badges/resolve/main/open-in-hf-spaces-sm-dark.svg" alt="Open PhysArena on Hugging Face">
13+
</a>
14+
</p>

docs/source/plaid_benchmarks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ As of August 5, 2025
6161

6262
The code to reproduce these results is available in [this repository](https://github.com/PLAID-lib/plaid-benchmarks).
6363

64-
!!! note
64+
!!! note "Benchmark interpretation notes"
6565

6666
- MMGP does not support variable mesh topologies, which limits its applicability to certain datasets and often necessitates custom preprocessing for new cases. However, when morphing is either unnecessary or inexpensive, it offers a highly efficient solution, combining fast training with good accuracy (e.g., `Tensile2d` and `Rotor37`).
6767
- MARIO is computationally expensive to train but achieves consistently a very strong performance across most datasets. Its result on `2D_MultiScHypEl` is slightly worse than other tested methods, which may reflect the challenge of capturing complex shape variability in these cases.

docs/source/quickstart.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ To use the library, the simplest way is to install it from the packages availabl
1414
pip install pyplaid
1515
```
1616

17-
**Note**
18-
19-
- Conda-forge packages for all supported operating systems (Linux, macOS, and Windows) and the Linux PyPI package include a bundled pyCGNS dependency. In other situations, which we have not tested, pyCGNS must be installed separately beforehand.
20-
- On Apple Silicon, users can force an osx-64 conda environment using CONDA_SUBDIR=osx-64, allowing installation of the existing macOS-64 builds under Rosetta.
17+
!!! note "Installation notes"
18+
- Conda-forge packages for all supported operating systems (Linux, macOS, and Windows) and the Linux PyPI package include a bundled pyCGNS dependency. In other situations, which we have not tested, pyCGNS must be installed separately beforehand.
19+
- On Apple Silicon, users can force an osx-64 conda environment using CONDA_SUBDIR=osx-64, allowing installation of the existing macOS-64 builds under Rosetta.
2120

2221

2322
## 2. Core concepts

docs/source/tutorials/storage.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -356,12 +356,13 @@ sample = converter.to_plaid(
356356
)
357357
```
358358

359-
- `indexers` is a mapping `feature_path -> indexer` (list/array of indices or slice).
360-
- Indexing is applied on the **last axis** of each indexed feature.
361-
- This enables a “read less + one gathered output copy” behavior:
362-
- **zarr**: partial chunk reads + gathered output
363-
- **hf_datasets**: Arrow/NumPy best-effort gather + gathered output
364-
- **cgns** backend does not use this mechanism.
359+
!!! info "Indexer behavior"
360+
- `indexers` is a mapping `feature_path -> indexer` (list/array of indices or slice).
361+
- Indexing is applied on the **last axis** of each indexed feature.
362+
- This enables a “read less + one gathered output copy” behavior:
363+
- **zarr**: partial chunk reads + gathered output
364+
- **hf_datasets**: Arrow/NumPy best-effort gather + gathered output
365+
- **cgns** backend does not use this mechanism.
365366

366367

367368
```python

docs/zensical.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ nav = [
133133
{ "CGNS Standard" = "https://cgns.org/" },
134134
{ "Muscat library" = "https://muscat.readthedocs.io/" },
135135
{ "PLAID Benchmarks" = "plaid_benchmarks.md" },
136+
{ "PhysArena" = "physarena.md" },
136137
] },
137138
]
138139

@@ -210,6 +211,16 @@ icon = "simple/anaconda"
210211
link = "https://anaconda.org/conda-forge/plaid"
211212
name = "plaid on conda-forge"
212213

214+
[[project.extra.social]]
215+
icon = "simple/arxiv"
216+
link = "https://arxiv.org/abs/2505.02974"
217+
name = "PLAID paper on arXiv"
218+
219+
[[project.extra.social]]
220+
icon = "simple/huggingface"
221+
link = "https://huggingface.co/PhysArena"
222+
name = "PhysArena on Hugging Face"
223+
213224
[project.validation]
214225
# Notebook text outputs contain CGNS tree dumps with square brackets (e.g.
215226
# ``[1 2 3]``) that are valid rendered content but look like reference-style

0 commit comments

Comments
 (0)