Documentation
From core to complete
Quatm Core is the open-source runtime for experiment control. It provides the experiment lifecycle, physics models, servers and shared utilities, and runs without a desktop environment.
Quatm Platform adds the desktop GUI, browser console, driver catalogue, licensing and support for laboratories that need a complete operating environment.
Quatm Systems extends the platform into the laboratory itself: real-time controllers, lasers, high-field magnets, RF sources, integrated ion-trap and ultracold-atom systems, and complete experimental systems.
Start here
Documentation should make an experiment feel smaller, not larger. These guides follow the way a real experiment comes to life: describe the apparatus, write the sequence, observe what happens, and keep what you learn.
If this is your first visit, begin with Getting started. It asks nothing of your hardware; simulation mode uses the same experiment model as the real apparatus. From there, follow the path that matches your work:
Getting started → Experiment editing → Device drivers → Data and analysis → Application examples.
Documentation map
| Section | What you will learn |
|---|---|
| Architecture | Services, processes and the boundaries that keep an experiment legible |
| Getting started | Installation, project layout, device configuration and a first experiment |
| FAQ | Common installation, device, data and upgrade questions |
| Experiment editing | The Experiment lifecycle, parameter types and timing primitives |
| Experiment framework | Widgets, queue, scheduler, preparation station, looper and timeline internals |
| Utilities | Shared utilities and VDS helpers |
| Device drivers | Device modes, driver catalogue and custom driver development |
| Data and analysis | Data streams, archive structure, imaging and fitting |
| GUI components | Desktop applications and their responsibilities |
| Web remote control | Browser console, mobile operation and synchronisation |
| Communication layer | Message hubs, clients, properties and configuration |
| Physics models | Atom database, optical dipole traps, Stark shifts and scattering |
| Monitoring | Environmental and instrument-health monitoring |
| Deployment | Single workstation, split control/analysis machines and remote access |
| Best practices | Safe shutdown, single responsibility and reusable components |
| Examples | Complete MOT, absorption-imaging and ion-trap experiments |
| Contributing | Issues, pull requests and review expectations |
Architecture
Quatm is not a single program. Drivers, data managers, property logging, message routing, web access and the GUI can run as independent services, sharing one experiment model across a workstation or a network.