Getting_Started

Getting Started with Compitum

This notebook helps you verify your environment and shows a minimal import of the Compitum package.

• Repository: https://github.com/PaulTiffany/compitum
• Wiki: https://github.com/PaulTiffany/compitum/wiki

Environment Setup

From the repository root, install Jupyter and Compitum in editable mode (once per environment):

# Windows (PowerShell)
python -m venv .venv
.venv\\Scripts\\Activate.ps1
pip install --upgrade pip
pip install jupyter
pip install -e .
python -m ipykernel install --user --name compitum-venv --display-name "Python (compitum)"
jupyter notebook

After activation, select the "Python (compitum)" kernel for this notebook.

# Python and pip versions
import sys, subprocess
print(sys.version)
subprocess.run([sys.executable, '-m', 'pip', '--version'], check=False)

3.10.20 (main, Jun 16 2026, 21:01:32) [GCC 13.3.0]
pip 26.1.2 from /opt/hostedtoolcache/Python/3.10.20/x64/lib/python3.10/site-packages/pip (python 3.10)





CompletedProcess(args=['/opt/hostedtoolcache/Python/3.10.20/x64/bin/python', '-m', 'pip', '--version'], returncode=0)

# Minimal Compitum import and version check
import compitum
print('Compitum version:', getattr(compitum, '__version__', 'unknown'))
print('Compitum modules:', compitum.__all__)

Compitum version: 0.2.0
Compitum modules: ['router', 'metric', 'constraints', 'coherence', 'boundary', 'control', 'energy']

Next Steps

• Explore API docs in src/compitum/.
• Check examples/ for scripts that use the router and metrics.
• See the Wiki for walkthroughs and deeper explanations.