Running Locally

This page covers the cross-cutting local setup for CAS Backend. Module-specific details stay in the module READMEs.

Prerequisites

  • Python 3.12

  • Poetry

  • A local or reachable PostgreSQL instance

  • A populated settings/.env file at the repository root

Initial Setup

make setup
make install
cp settings/sample_env settings/.env

Fill in the values required for your environment before starting services.

Running the Compute Service

poetry run python -m cellarium.cas_backend.apps.compute.main

OpenAPI docs are available at http://localhost:8000/api/docs.

Running the Admin Service

poetry run python -m cellarium.cas_backend.apps.admin.server

Testing and Linting

make test
make lint

Vertex AI Access

Some compute flows depend on network access to Vertex AI Matching Engine. For local debugging in an environment that requires a bastion, authenticate with gcloud auth login and then create the tunnel:

gcloud compute ssh --zone "us-central1-a" "bastion" --project "dsp-cell-annotation-service" -- -NL 10000:localhost:10000

See Vertex AI Matching Engine for the broader Matching Engine background.