CANFAR Clients¶
A powerful Python API and CLI for the CANFAR Science Platform.
API
from canfar.sessions import Session
session = Session()
ids = session.create(
name="test",
image="images.canfar.net/skaha/astroml:latest",
kind="headless",
cmd="env",
env={"KEY": "VALUE"},
replicas=3,
)
print(ids)
from canfar.sessions import AsyncSession
session = AsyncSession()
ids = await session.create(
name="test",
image="images.canfar.net/skaha/astroml:latest",
kind="headless",
cmd="env",
env={"KEY": "VALUE"},
replicas=3,
)
print(ids)
from canfar.sessions import AsyncSession
async with AsyncSession() as session:
ids = await session.create(
name="test",
image="images.canfar.net/skaha/astroml:latest",
kind="headless",
cmd="env",
env={"KEY": "VALUE"},
replicas=3,
)
print(ids)
CLI
Create a Session
canfar launch headless --env KEY=VALUE --replicas 3 images.canfar.net/skaha/astroml:latest
Installation
Install from PyPI
pip install canfar
Add as Dependency
uv add canfar