Installation¶

Prerequisites: Python 3.11 or higher

You can install CoMPASS-Labyrinth directly with pip:

pip install compass-labyrinth

or from source for development:

git clone https://github.com/CoMPASS-Framework/CoMPASS-Labyrinth.git
cd CoMPASS-Labyrinth

# Core dependencies only
pip install -e .

# Or with development tools
pip install -e ".[dev]"

# Or with documentation tools
pip install -e ".[docs]"

# Or install all optional dependencies
pip install -e ".[dev,tests,docs]"

You can also use Conda to manage your environment:

conda env create -f environment.yml
conda activate compass-labyrinth

Next Steps¶

Now that you have CoMPASS-Labyrinth installed, you can:

Explore the Tutorials to learn how to use the framework
Check the API Reference for detailed documentation

For more help, please open an issue on GitHub.