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	requested format wasn't in the original output_formats
HTTPStatusError	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[MSAResult]

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	destination folder	None
max_credits	int | None	maximum credits for the workflow	None
webhook_url	str | None	URL that Rowan will POST to when the workflow completes	None
is_draft	bool	save as a draft without starting execution	False

Returns:

Type	Description
Workflow[MSAResult]	workflow object representing the submitted MSA workflow

Raises:

Type	Description
HTTPStatusError	API request fails