2. Detailed installation

This page covers a clean, isolated installation on each operating system. We strongly recommend installing into a dedicated environment so LatticeMind’s dependencies never collide with other Python projects.

2.1. Requirements

Python 3.10, 3.11, or 3.12. The 0.2.0 release provides cp310, cp311, and cp312 wheels. Use the wheel matching both the Python tag and the operating-system architecture.
Internet access for the AI model (the calculations themselves can run offline) and normally for pip to resolve Python dependencies.
A valid RESCU license file. LatticeMind checks it before the CLI or Web UI starts, even when NanoDCAL is selected.
An AI provider API key (see Connecting your AI model).
(To run calculations) the selected solver and its licensed data. NanoDCAL requires its own solver license and NeutralAtomDatabase in addition to the RESCU license used by LatticeMind (see Licenses and solver executables).

2.2. Option A — Conda / Miniconda (recommended)

Conda gives you a clean, reproducible Python environment on any platform.

conda create -n latticemind python=3.10
conda activate latticemind
python -m pip install path/to/lattice_mind-0.2.0-<matching-tags>.whl

2.3. Option B — Python virtual environment

If you do not use Conda, a standard virtual environment works just as well.

Windows (PowerShell):

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install path\to\lattice_mind-0.2.0-<matching-tags>.whl

macOS / Linux:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install path/to/lattice_mind-0.2.0-<matching-tags>.whl

2.4. Verify the installation

After installation, these commands should be available on your PATH:

Command	Purpose
`latticemind`	Start the assistant (Dashboard / Web UI / CLI chooser).
`latticemind-web`	Launch the browser-based Web UI directly.

Confirm that the intended environment contains version 0.2.0:

python -c "from importlib.metadata import version; print(version('lattice-mind'))"

Then install the RESCU license as described in Licenses and solver executables before starting latticemind or latticemind-web.

2.5. What gets installed

The wheel installs everything LatticeMind needs to build, validate, and analyse calculations, including the post-processing libraries h5py (RESCU .mat and .h5 outputs), scipy (legacy MATLAB files and numerical helpers), and matplotlib (Python plots when RESCU’s own plotting does not cover a requested figure). It also bundles:

the RESCU documentation used for retrieval — built in and offline, no setup required (see Licenses and solver executables);
a runtime pseudopotential archive for turnkey RESCU execution;
the Web UI assets.

Note

You do not need MATLAB, a compiler, or any build tools to use LatticeMind. Those are only relevant if you build the package from source, which is a developer task.

Continue to Connecting your AI model to connect your AI model, then Licenses and solver executables to configure the RESCU license used by LatticeMind and RESCU execution. If you plan to run NanoDCAL, that page also explains the separate NanoDCAL license and NeutralAtomDatabase setup.