MSA

MSA workflow - Multiple Sequence Alignment for proteins.

MSAResult dataclass

MSAResult(
    workflow_data: dict[str, Any],
    workflow_type: str,
    workflow_uuid: str,
    complete: bool = True,
)

Bases: WorkflowResult

Result from a Multiple Sequence Alignment (MSA) workflow.

download_files

download_files(
    format: MSAOutputFormat | MSAFormat | None = None,
    path: Path | str | None = None,
) -> list[Path]

Download MSA files for this workflow.

Parameters:

Name	Type	Description	Default
format	MSAOutputFormat | MSAFormat | None	Output format to download. If None, downloads all requested formats.	None
path	Path | str | None	Directory to save files to. Defaults to current directory.	None

Returns:

Type	Description
list[Path]	List of paths to downloaded tar.gz files.

Raises:

Type	Description
ValueError	If the requested format wasn't in the original output_formats.
HTTPError	If the API request fails.

submit_msa_workflow

submit_msa_workflow(
    initial_protein_sequences: list[str | ProteinSequence],
    output_formats: set[MSAOutputFormat | MSAFormat]
    | None = None,
    name: str = "MSA Workflow",
    folder_uuid: str | None = None,
    folder: Folder | None = None,
    max_credits: int | None = None,
    webhook_url: str | None = None,
    is_draft: bool = False,
) -> Workflow

Submits a Multiple Sequence Alignment (MSA) workflow to the API.

Parameters:

Name	Type	Description	Default
initial_protein_sequences	list[str | ProteinSequence]	List of protein sequences to align (amino acid strings).	required
output_formats	set[MSAOutputFormat | MSAFormat] | None	Output formats for the MSA files. Defaults to {MSAFormat.COLABFOLD}.	None
name	str	Name to assign to the workflow.	'MSA Workflow'
folder_uuid	str | None	UUID of the folder where the workflow will be stored.	None
folder	Folder | None	Folder object to store the workflow in.	None
max_credits	int | None	Maximum number of credits to use for the workflow.	None
webhook_url	str | None	URL that Rowan will POST to when the workflow completes.	None
is_draft	bool	If True, submit the workflow as a draft without starting execution.	False

Returns:

Type	Description
Workflow	Workflow object representing the submitted MSA workflow.

Raises:

Type	Description
HTTPError	If the API request fails.