Skip to content

Commit e657242

Browse files
committed
Added recommendation for local installation if using GUI
1 parent fdca5c1 commit e657242

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/docs/gui.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,17 @@ PartiNet includes a browser-based graphical interface built with Gradio. It cove
88

99
![PartiNet GUI overview](/img/gui_overview.png)
1010

11+
:::tip Recommended installation
12+
Run the GUI from a **local Python installation** ([Installation](installation.md) — pip, conda, or a virtualenv on your workstation or cluster login node). Apptainer/Singularity and Docker images are intended for the **CLI** pipeline on HPC; running `partinet gui` inside a container is possible but not recommended.
13+
14+
For large-scale or automated processing, the CLI remains the recommended approach.
15+
16+
A local install avoids extra bind-mount and cache setup (`--no-home`, Hugging Face theme cache), keeps Slurm tools (`sbatch`, `scancel`) on the host PATH, and makes SSH port forwarding straightforward. On HPC, use the GUI locally on the login node and submit compute-heavy work via **Slurm**
17+
:::
18+
1119
## Launching the GUI
1220

13-
```shell title="Local Installation"
21+
```shell title="Local Python installation"
1422
partinet gui
1523
```
1624

@@ -166,17 +174,9 @@ Click **Generate STAR File** to write a CryoSPARC-compatible `.star` file. The c
166174

167175
**RELION output** is available under the optional accordion — enable it to also produce a `pick.star` and per-micrograph coordinate files in the RELION project directory format.
168176

169-
## GUI vs CLI
170177

171-
| | GUI | CLI |
172-
|---|---|---|
173-
| Audience | Beginners, interactive exploration | Experienced users, scripting, HPC |
174-
| Log output | Streamed live in the browser | Terminal / log file |
175-
| Threshold tuning | Interactive slider with live preview | Set once at run time |
176-
| Automation | Slurm submission from GUI | Fully scriptable |
177-
| HPC | Login-node GUI + Slurm batch jobs | Apptainer / Docker / modules |
178178

179-
For large-scale or automated processing, the CLI remains the recommended approach.
179+
180180

181181
## What's Next
182182

0 commit comments

Comments
 (0)