Installation using uv

This project requires Python 3.11. The installation is managed using uv.

Dependencies are listed in the pyproject.toml file and locked in the uv.lock file.

1. Navigate to where you want to clone this repository

cd /path/to/directory/

2. Clone the repo from GitHub

git clone git@github.com:mesoscope/cellpack.git
cd cellpack

3. Install the dependencies using uv

For basic installation with just the core dependencies:

uv sync --no-dev

If you plan to develop code, you should also install the development dependencies:

uv sync

To install extra dependencies:

uv sync --all-extras

4. Activate the virtual environment

Activate the virtual environment in the terminal:

For Windows:

\path\to\venv\Scripts\activate

For Linux/Mac:

source /path/to/venv/bin/activate

You can deactivate the virtual environment using:

deactivate

To run the tests, use:

uv run pytest

Provide feedback