Installation¶

Get ScanMST installed on your system in just a few minutes.

Prerequisites¶

!!! info "Requirements" - Python: 3.9-3.10 for v0.1.9 (the current release); 3.11-3.13 for the development version on main - Operating System: Linux

Installation Methods¶

Choose your preferred installation method:

pipcondauvfrom source

The easiest way to install ScanMST:

pip install scanmst

Verify the installation:

scanmst --version

Install using conda:

conda install -c conda-forge scanmst

Or create a new environment:

conda create -n scanmst python=3.10
conda activate scanmst
pip install scanmst

Using the fast uv package manager:

uv pip install scanmst

Or with a virtual environment:

uv venv
source .venv/bin/activate
uv pip install scanmst

For development or the latest features:

# Clone the repository
git clone https://github.com/ylab-hi/ScanMST.git
cd ScanMST

# Install with Poetry
poetry install

# Verify installation
scanmst --version

Verification¶

Confirm ScanMST is installed correctly:

# Check version
scanmst --version

# View available commands
scanmst --help

Troubleshooting Installation¶

Common Issues¶

ImportError: No module named 'scanmst'

Solution: Ensure you've activated the correct Python environment:

# Check which Python is being used
which python

# Reinstall in the current environment
pip install --force-reinstall scanmst

Permission denied errors

Solution: Install in user space without sudo:

pip install --user scanmst

For more issues, see the Troubleshooting Guide.

Next Steps¶

Now that ScanMST is installed, try the Quick Start tutorial to run your first prediction!