Installation

CELL is published as clusterx on PyPI and imported in Python as clusterx. For the current source checkout, use Python 3.12 or newer.

Install with uv

With uv installed, add CELL from your project directory.

uv add clusterx

If you are starting a new project, run uv init --python 3.12 in an empty directory first. uv creates and manages the project’s virtual environment when you add dependencies.

Check your installation

Run these commands from your project directory to check the import, installed version, and command-line interface.

uv run python -c "import clusterx; from importlib.metadata import version; print(version('clusterx'))"
uv run cell --help

This documentation is built against CELL 2.4.0. Check your installed version when following the tutorials or API examples. The PyPI release and public GitHub checkout may be older.

For notebook setup, see Running the tutorials in Jupyter. For command syntax, see the CLI reference.

Install from source

To edit CELL locally, clone the public repository next to your project. Run these commands from your project directory.

git clone https://github.com/srigamonti/clusterx.git ../clusterx
uv add --editable ../clusterx

An editable install uses the Python source from the checkout directly.

Running the tests

With the editable dependency installed, you can run CELL’s test suite from your project directory.

uv run cell test

Install with pip

If you already manage your Python environment with pip, install CELL there.

python -m pip install clusterx