Object to simplify scenario creation, configuration and run. This can be used in a Jupyter Notebook
:raises Exception: [description] :return: [description] :rtype: [type]
Functions
__init__
This create a scenario in the database with the provided Task or Protocol
protocol_type :
Type folder :
SpaceFolder scenario title
title :
str - '' scenario title
creation_type :
ScenarioCreationType - ScenarioCreationType.AUTO type of the created scenario
scenario_id :
str If provided, other parameters are ignored, it loads an existing scenario
add_tag
tag :
Tag add_tags
tags :
List add_to_queue
delete
get_model
Return type :
Scenario get_model_id
Return type :
str get_protocol
retrieve the main protocol of the scenario
Return type :
ProtocolProxy get_url
Return type :
str is_finished
Return type :
bool is_running
Return type :
bool is_success
Return type :
bool refresh
Return type :
ScenarioProxy run
execute the scenario, after that the resource should be generated and can be retrieve by process
auto_delete_if_error :
bool - False run_async
Run the scenario in a separate process but don't wait for it to finish
Return type :
ScenarioWaiterBasic stop
from_existing_scenario @staticmethod
Create a ScenarioProxy from an existing scenario
scenario_id :
str id of the scenario
Return type :
ScenarioProxy