LUME Visual Dashboard
A React dashboard for visualizing LUME accelerator models next to live machine data.
It talks to two backends, both called directly from the browser:
| Backend |
Provides |
Code |
| lume-model-api |
The model list, each model’s config, evaluate, and a live stream of the model run at the machine’s current inputs |
src/api/ |
| Canopy (its Hare module) |
Live EPICS PV values and metadata over REST and a WebSocket |
src/api/canopy/ |
Both are git submodules in external/, and compose.yaml runs them locally with simulated machine data.
Where to start
- New to the project: Getting started covers cloning, installing, running everything locally, and the
pnpm commands.
- Working on the app:
- Deploying:
- Editing these docs: Documentation.
Stack
- React 19 with TypeScript, built with Vite
- TanStack Router for file-based, type-safe routing (each model and mode has its own URL)
- TanStack Query for fetching and caching, with types generated from each API’s OpenAPI schema
- Carbon Design System and ECharts for UI and plots
- Vitest, React Testing Library and MSW for tests
- ESLint, Prettier and Husky pre-commit hooks