Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

ProcessHandle

class cstar.orchestration.orchestration.ProcessHandle(*, pid: str, name: str, run_id: str, launcher_name: str = '', status: Status = Status.Unsubmitted, **extra_data: Any)

Bases: BaseModel

Contract used to identify processes created by any launcher.

Attributes

ProcessHandle.safe_name	Return a path-safe version of the name.
ProcessHandle.pid	The process identifier.
ProcessHandle.name	The name of the process.
ProcessHandle.run_id	The run-id the process was run under.
ProcessHandle.launcher_name	The launcher used to launch the process.
ProcessHandle.status	The current status of the task.