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.

Status

class cstar.orchestration.orchestration.Status(*values)

Bases: IntEnum

The state of a running task.

Methods

Status.terminal_states()	Return the set of terminal statuses.
Status.is_terminal(status)	Return True if a status is in the set of terminal statuses.
Status.failure_states()	Return the set of failure statuses.
Status.is_failure(status)	Return True if a status is in the set of terminal statuses.
Status.ready_states()	Return the set of ready statuses.
Status.is_ready(status)	Return True if a status is in the set of ready statuses.
Status.running_states()	Return the set of running statuses.
Status.is_running(status)	Return True if a status is in the set of running statuses.
Status.in_progress_states()	Return the set of in-progress statuses.
Status.is_in_progress(status)	Return True if a status is in the set of in-progress statuses (any non-terminal status).

Attributes

Status.Unsubmitted	A task that has not been submitted by a launcher.
Status.Submitted	A task that has been submitted by a launcher and awaits a status update.
Status.Running	A task that was submitted and has not terminated.
Status.Ending	A task that has reported itself as nearing completion.
Status.Done	A task that has terminated without error.
Status.Cancelled	A task terminated due to cancellation (by the user or system).
Status.Failed	A task that terminated due to some failure in the task.