User Guide
How to install Orbitron, load data, and operate the desktop viewer, automation CLI, terminal UI, remote SSH/SFTP access, and Python bindings. Each topic is its own page — use the sidebar, or start here:
- Install — prebuilt apps, Python wheels, web viewer
- Data Support — every format Orbitron parses, and per-format charge coverage
- Graphical Viewer — launching, controls, keyboard shortcuts, selection, rendering, the Analysis panel, edit mode, sessions
- Automation CLI —
orbitronheadless commands and the selection grammar - Terminal UI —
orbitron-tuifor ssh-into-HPC inspection - Remote Files (SSH/SFTP) — opening files on a remote host
- Python Bridge — Jupyter, scripting, and headless rendering
- Web Viewer Embedding — HTML for slides, the
<orbitron-viewer>web component - Troubleshooting
- Quick Reference — one-line recipes
- Limitations — what Orbitron is and isn’t for