Installation#

Requirements#

Python ≥ 3.11
A running Lab Streaming Layer (LSL) stream or any MNE-readable file for mock mode (.fif, .vhdr, .edf, .bdf, .set, …)
FreeSurfer subjects directory (only for source-localisation and brain-plot features)

pip (recommended)#

# Latest release (OSC output included)
pip install mne-rt

# All optional extras (viz, dev, docs)
pip install "mne-rt[full]"

Editable / development install#

git clone https://github.com/payamsash/ANT.git
cd ANT
pip install -e ".[dev]"

uv — recommended fast installer#

uv resolves and installs packages in Rust — typically 10–20× faster than plain pip. It reads pyproject.toml directly and handles all extras.

# Install uv once
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install mne-rt into an active environment
uv pip install mne-rt
uv pip install "mne-rt[full]"   # all extras (viz, dev, docs)

# Editable install from source (recommended for development)
git clone https://github.com/payamsash/mne-rt.git
cd mne-rt
uv pip install -e ".[dev]"

Note

uv add mne-rt is for adding mne-rt as a dependency of another project. Inside the mne-rt source tree use uv pip install -e . instead.

conda / mamba#

The provided environment.yml creates a complete conda environment. mamba (or micromamba) is strongly recommended over plain conda because it uses a faster C++ dependency solver.

# Install mamba into base (once)
conda install -n base -c conda-forge mamba

# Create the mne-rt environment
mamba env create -f environment.yml   # ~2 min

# Or with plain conda (slower)
conda env create -f environment.yml

# Activate
conda activate ant

# Update after pulling new changes
mamba env update -f environment.yml --prune

Verifying#

mne-rt info     # prints MNE-RT and dependency versions
mne-rt demo     # runs a 120-second mock real-time session

Optional extras#

Extra	What it adds	Install command
`viz`	3D brain visualisation (pyvista, pyvistaqt) — needed for BrainPlot	`pip install "mne-rt[viz]"`
`dev`	Testing only (pytest, pytest-cov)	`pip install "mne-rt[dev]"`
`lint`	Linting and formatting (ruff, mypy, pre-commit)	`pip install "mne-rt[lint]"`
`docs`	Documentation build tools (Sphinx, sphinx-gallery, …)	`pip install "mne-rt[docs]"`
`full`	All of the above	`pip install "mne-rt[full]"`