1. Quick start

This is the shortest path from a fresh machine to your first result.

  1. Install the matching wheel you received from Nanoacademic. The cp310, cp311, or cp312 tag must match Python 3.10, 3.11, or 3.12:

    python -m pip install /path/to/lattice_mind-0.2.0-<matching-tags>.whl

  2. Install the RESCU license used by LatticeMind. Put exactly one *.lic or *.license file in ~/.nanoacademic/RESCU. On Windows that expands to C:\Users\<username>\.nanoacademic\RESCU. For any other location, set:

    LATTICEMIND_LICENSE_FILE=/full/path/to/rescu.lic

  3. Add your AI provider API key. OpenAI is the default:

    export OPENAI_API_KEY="your_key_here"     # macOS / Linux

    $env:OPENAI_API_KEY="your_key_here"       # Windows (PowerShell)

  4. Start LatticeMind:

    latticemind

Then just type what you want. For example:

Do a simple SCF and band structure calculation for silicon.

LatticeMind will plan the workflow, build the silicon structure, generate and validate the RESCU inputs, and show you the launch preview. Solver execution is controlled by the explicit /execute on and /execute off commands, not by wording in the calculation prompt. Execution is off by default.

Tip

Type /examples inside the app for ready-to-run prompts, or /commands to browse everything LatticeMind can do.

Prefer a browser? Launch the web interface instead:

latticemind-web

It opens at http://127.0.0.1:7865 by default.

Note

Configure the RESCU license from step 2 before starting LatticeMind. The same license supports RESCU execution. To run a project, also configure the selected solver executable. NanoDCAL execution uses a separate NanoDCAL license and the NeutralAtomDatabase. See Licenses and solver executables.

1.1. Where do results go?

By default LatticeMind writes projects and outputs to a latticemind_outputs/ folder in your current working directory. Each project is a self-contained folder with the generated inputs, results, plots, a report, and a full event log. See Projects & the workspace for the layout.

To store outputs elsewhere (recommended on shared machines and cloud), set:

export LATTICEMIND_ARTIFACTS_DIR="/path/to/outputs"

1.2. What next?