citrine.informatics.workflows.workflow module

Tools for working with workflow resources.

class citrine.informatics.workflows.workflow.Workflow

Bases: AsynchronousObject

A Citrine Workflow is a collection of Modules that together accomplish some task.

All workflows must inherit AIResourceMetadata, and hence have a status field. Possible statuses are INPROGRESS, SUCCEEDED, and FAILED. Workflows also have a status_description field with more information.

failed() → bool

Whether the backend process has completed unsuccessfully.

in_progress() → bool

Whether the backend process is in progress.

succeeded() → bool

Whether the backend process has completed successfully.

description = None

name = None

project_id: UUID | None = None

Unique ID of the project that contains this workflow.

Type:

Optional[UUID]

uid = None

Citrine Platform unique identifier

Type:

Optional[UUID]