Membrane Permeability
Membrane permeability workflow - predict membrane permeability.
MembranePermeabilityResult
dataclass
MembranePermeabilityResult(
workflow_data: dict[str, Any],
workflow_type: str,
workflow_uuid: str,
complete: bool = True,
)
submit_membrane_permeability_workflow
submit_membrane_permeability_workflow(
initial_molecule: StructureInput | SMILES,
method: Literal["gnn-mtl", "pypermm"] = "gnn-mtl",
name: str = "Membrane Permeability 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 membrane-permeability workflow to the API.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
initial_molecule
|
StructureInput | SMILES
|
Molecule used in the workflow. |
required |
method
|
Literal['gnn-mtl', 'pypermm']
|
Method used to compute membrane permeability. |
'gnn-mtl'
|
name
|
str
|
Name of the workflow. |
'Membrane Permeability Workflow'
|
folder_uuid
|
str | None
|
UUID of the folder to store the workflow in. |
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 workflow. |
Raises:
| Type | Description |
|---|---|
requests.HTTPError
|
if the request to the API fails. |