Skip to main content

Install

The desktop app is the recommended dicomqc interface. The CLI supports automation and scripted workflows; both use the same Python audit engine.

Desktop App​

Download the Desktop package for your operating system from GitHub Releases. You do not need to build the app from source.

Choose a download​

Expand Assets on the release page. Download the package for your computer, not the automatically generated Source code archives.

ComputerPackage for 0.2.0
Mac, Apple Silicon (M-series)dicomqc-0.2.0-macos-arm64.dmg
Mac, Inteldicomqc-0.2.0-macos-x64.dmg
Windows, Intel/AMD 64-bitdicomqc-0.2.0-windows-x64-setup.exe
Linux, Intel/AMD 64-bitdicomqc-0.2.0-linux-x64.AppImage
Linux, ARM64dicomqc-0.2.0-linux-arm64.AppImage

Desktop bundles its Python engine; you do not need to install Python, Node.js, or Rust separately. The Windows package is x64; there is no native Windows ARM64 package.

Verify a download (optional)

Download SHA256SUMS from the same release. Replace FILE below with your downloaded package's filename and run the command from its folder.

PlatformCommand
Linuxsha256sum FILE
macOSshasum -a 256 FILE
Windows PowerShellGet-FileHash FILE -Algorithm SHA256

Compare the result with the matching filename in SHA256SUMS. Checksums detect damaged or changed downloads; they do not replace code signing.

macOS​

  1. Check About This Mac and choose the Apple Silicon or Intel download.
  2. Open the .dmg and drag dicomqc into Applications.
  3. Eject the disk image, then open dicomqc from Applications.

There is no installer wizard on macOS: copying the app into Applications is the installation step. Use the ARM64 build on an M-series Mac.

First launch on macOS

These builds are not Apple-notarized. If macOS blocks the app, review Apple's guidance. After attempting to open it, macOS may offer Open Anyway under System Settings > Privacy & Security. Approve only the app you intentionally downloaded from this repository. Do not disable Gatekeeper; report unexpected security or damaged-app warnings.

First audit​

Once it is running, try the Desktop privacy audit example. Use Load example data beside DICOM inputs to try a synthetic dataset before selecting your own files. Finish the audit and use File > Save Project to save a .dicomqc project wherever you choose.

Storage and removal​

Where dicomqc stores application data

Settings, run history, reports, and working project data are stored separately from the application:

  • Linux: ~/.local/share/org.cnag.dicomqc/ (or $XDG_DATA_HOME/org.cnag.dicomqc/ if configured).
  • macOS: ~/Library/Application Support/org.cnag.dicomqc/.
  • Windows: %LOCALAPPDATA%\org.cnag.dicomqc\.

This folder keeps your settings and audit results between sessions, along with example data and working copies of projects. These files are not automatically deleted when you close the app.

You choose where to save .dicomqc project files. Your original DICOM files stay where they are and are never modified by dicomqc.

Save your project and quit the app before removing working data.

Update Desktop​

Save your project and quit dicomqc before updating:

  • macOS: replace the app in Applications with the copy from the new DMG.
  • Windows: run the newer setup executable and follow its wizard.
  • Linux: replace the AppImage and enable executable permission again if needed.

Uninstall or reset​

  1. Save projects and export any reports you want to keep outside application storage. Unsaved results may exist only in the working folder.
  2. Quit dicomqc. If you previously used a different working folder, its location is recorded in workspace.json inside the application data folder.
  3. To uninstall, delete the AppImage on Linux, remove the app from Applications on macOS, or run the dicomqc uninstaller from the Windows Start menu or Settings > Apps > Installed apps.
  4. On Windows, the uninstaller asks whether to Delete app data. Leave this unchecked to preserve settings and run history for a later reinstall. Select it only when you also want to remove reports and working data stored in the application-data folder listed above.
  5. On Linux or macOS, delete the application-data folder listed above only when you also want to reset settings and local history. Review and separately remove any external dicomqc working folder recorded in step 2. Do not delete your input datasets.

On Windows, the installed program directory under %LOCALAPPDATA% is separate from %LOCALAPPDATA%\org.cnag.dicomqc\. The program directory is removed during uninstall; the application-data directory is removed when Delete app data is selected.

Deleting application data without uninstalling resets the local working state; dicomqc recreates it on the next launch. Separately saved .dicomqc projects, exported reports, and original DICOM datasets are not removed by this cleanup.

Save before cleaning up

Deleting working storage removes its run history and reports, including unsaved work. Save the project first; a saved project contains reports and settings but does not embed the original DICOM inputs.

External DICOM tools​

DCMTK, Orthanc, and other pseudonymization or remediation tools are not dicomqc dependencies. Install them separately only when they are part of the local DICOM transformation workflow. dicomqc itself remains read-only.

Continue with the Desktop example or CLI walkthrough to run your first audit with synthetic data.