Pip Installation

Use this method if you want to install CaliBrain from a local repository checkout.

Clone the repository

Download the source code and move into the project directory:

git clone https://github.com/braindatalab/CaliBrain.git
cd CaliBrain

Create an isolated Python environment

It is recommended to install into a virtual environment:

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip

Install CaliBrain from the checkout

Install the package in editable mode:

python -m pip install -e .

Editable mode means that changes in the local source tree are available without reinstalling the package.

Optional extras

Install documentation dependencies:

python -m pip install -e ".[docs]"

Install development dependencies:

python -m pip install -e ".[dev]"

Check that the installation worked

python -c "import calibrain; print(calibrain.__version__)"