Installation

QCLM has two parts, and you need both:

Part	What it is	How you install it
Desktop app	The window you work in: instrument control, viewer, analysis	A normal installer for your OS (this page)
Backend	Services that store and process the data	One Docker command (Backend setup)

The desktop installers include their own Java runtime, so you don't need to install Java.

System requirements

	Minimum	Recommended
OS	macOS 12, Windows 10, Ubuntu 22.04 (or another Debian-based distro)	Latest release
Memory	8 GB	16 GB or more for large cubes
Disk	2 GB for the app and backend images	Plus space for your data
Display	1280 × 800	1920 × 1080 or larger

You also need Docker for the backend; see Backend setup.

Download

macOS Apple Silicon (.dmg) macOS Intel (.dmg) Windows 64-bit (.msi) Linux Debian / Ubuntu (.deb)

Each release also lists every file with a SHA256SUMS.txt, on the releases page.

Which Mac do I have?

Click Apple menu → About This Mac. If it says Chip: Apple M…, choose Apple Silicon. If it says Processor: Intel, choose Intel.

Install

macOSWindowsLinux

1. Open the downloaded QCLM-macOS-….dmg.
2. Drag QCLM into your Applications folder.
3. Eject the disk image.
4. Open QCLM from Applications or Launchpad.

\"QCLM can't be opened because Apple cannot check it for malicious software\"

Current builds are not yet notarized by Apple. The first time you open QCLM:

1. Right-click (or Control-click) QCLM in Applications and choose Open.
2. Click Open in the dialog.

On macOS 15 and later, you may instead need to open System Settings → Privacy & Security, scroll down to the message about QCLM and click Open Anyway.

You only need to do this once.

1. Run the downloaded QCLM-Windows-x64.msi.
2. Follow the installer. QCLM installs for your user account only, so you don't need administrator rights.
3. Start QCLM from the Start menu or the desktop shortcut.

\"Windows protected your PC\"

Current builds are not yet code-signed, so SmartScreen may warn you. Click More info → Run anyway.

Install the package with apt, which also pulls in its dependencies:

sudo apt install ./QCLM-Linux-x64.deb

QCLM appears in your application menu under Science. You can also start it from a terminal:

/opt/qclm/bin/QCLM

Updating

In the app, click the gear button at the bottom of the left sidebar and choose Check for Updates to see whether a newer version exists. To update, download the new installer and install it over the old one. Your settings are kept.

When you update the desktop app, update the backend to the same version as well; see Updating the backend.

Uninstalling

macOSWindowsLinux

Drag QCLM from Applications to the Trash.

Go to Settings → Apps → Installed apps → QCLM → Uninstall.

sudo apt remove qclm

Uninstalling the app does not delete your data. Data stored by the backend lives in Docker volumes; see Removing the backend.

---

Next: Backend setup