Installation¶
Google Colab (Recommended for trying out)¶
No local setup required. Just open a notebook and run:
Set your HuggingFace token in Colab Secrets (key icon in left sidebar):
- Key:
HF_TOKEN - Value: Your token from huggingface.co/settings/tokens
- Toggle "Notebook access" ON
Local Installation¶
With uv (recommended)¶
# Clone the repository
git clone https://github.com/modulabs-personalab/psyctl.git
cd psyctl
# Create virtual environment and install
uv venv
source .venv/bin/activate # Linux/macOS
uv sync
With pip¶
GPU Support (CUDA)¶
After installation, install CUDA-enabled PyTorch:
Verify:
Note
uv sync installs CPU-only PyTorch by default. Run the CUDA command above to enable GPU support.
Environment Variables¶
Required:
Optional:
| Variable | Default | Description |
|---|---|---|
PSYCTL_INFERENCE_BATCH_SIZE |
16 | Batch size for inference |
PSYCTL_LOG_LEVEL |
INFO | Logging level |
PSYCTL_CACHE_DIR |
./temp | HuggingFace cache location |
OPENROUTER_API_KEY |
- | For OpenRouter API integration |
See Configuration for the full list.