Skip to content

Installation

There are two ways to get AutoPhaseAnalysis: download the packaged app (macOS, no Python required), or run from source (any platform).

Download the app (macOS)

Grab the packaged app from the GitHub Releases page:

  1. Download AutoPhaseAnalysis-0.1.0-macos-arm64.zip (Apple Silicon).
  2. Unzip and drag AutoPhaseAnalysis.app into Applications.
  3. On first launch macOS will warn that the app is from an unidentified developer — right-click the app → Open (or allow it under System Settings → Privacy & Security). The app is ad-hoc signed, not notarized.

Windows version coming soon

A packaged Windows version of the app will be released soon. Until then, Windows (and Linux) users can run from source below.

Requirements (from source)

Requirement Detail
Python 3.13 (developed and tested against 3.13.5)
OS macOS, Linux, or Windows
Internet Needed on first run (BGMN download) and when searching a new chemical system against COD

BGMN binaries are downloaded and installed automatically to a per-user directory (~/.autophaseanalysis/bgmn) on first use — no manual setup required.

Install from source

git clone https://github.com/jomat733-ops/AutoPhaseAnalysis.git
cd AutoPhaseAnalysis

python3.13 -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate

pip install -r requirements.txt

Do not un-pin dara

The dara dependency is pinned to a specific commit that the app's compatibility patches (app/patches.py) were written against. Un-pinning it without re-verifying those patches can break XRDML parsing and the BGMN binary paths.

Verify the install

python main.py

The main window should open. On the very first launch, the app fetches the BGMN engine (a few seconds) before it is ready.

Next steps