Object to simplify scenario creation, configuration and run. This can be used in a Jupyter Notebook
:raises Exception: [description] :return: [description] :rtype: [type]
Functions
This create a scenario in the database with the provided Task or Protocol
If this is a task, it will be wrapped in a protocol
If none it will create an empty protocol in the scenario
:raises Exception: [description]
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| protocol_type | Type | ||
| folder | SpaceFolder | Scenario title, defaults to '' str, optional | |
| title | str | '' | Scenario title, defaults to '' , optional |
| creation_type | ScenarioCreationType | ScenarioCreationType.AUTO | Type of the created scenario, defaults to scenarioexecutiontype.auto scenarioexecutiontype, optional |
| scenario_id | str | If provided, other parameters are ignored, it loads an existing scenario, defaults to none , optional |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| tag | Tag |
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| tags | List |
Return type:
Scenario |
Return type:
str |
retrieve the main protocol of the scenario
Return type:
ProtocolProxy |
Return type:
bool |
Return type:
bool |
Return type:
bool |
Return type:
ScenarioProxy |
execute the scenario, after that the resource should be generated and can be retrieve by process
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| auto_delete_if_error | bool | False |
Create a ScenarioProxy from an existing scenario
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
| scenario_id | str | Id of the scenario |
Return type:
ScenarioProxy |