soil.api

This package contains calls to the SOIL's REST API

upload_data#

def upload_data(dtype: str, data: Any, metadata: Any) -> Result

Upload data to the cloud as a new dataset.

get_result#

def get_result(result_id: str) -> Dict[str, Any]

Get the result data

get_result_data#

def get_result_data(result_id: str, query: Optional[Dict[str, str]] = None) -> Dict[str, Any]

Get the result data

export_result#

def export_result(result_id: str, file_path: str, query: Optional[Dict[str, str]] = None) -> None

Export result and saves it to a file

upload_module#

def upload_module(module_name: str, code: str, is_package: bool) -> None

Uploads a module

get_module#

def get_module(full_name: str) -> GetModule

Downloads a module

set_alias#

def set_alias(alias: str, result_id: str, roles: Optional[List[str]] = None) -> None

Sets an alias for a result. Updates a previous one with the same name.

get_alias#

def get_alias(alias: str) -> Dict[str, Any]

Gets an alias

create_experiment#

def create_experiment(plan: Plan) -> Experiment

Runs an experiment in SOIL

get_experiment#

def get_experiment(experiment_id: str) -> Experiment

Runs an experiment from SOIL

get_experiment_logs#

def get_experiment_logs(experiment_id: str, start_date: str) -> Any

Gets logs from a SOIL experiment

create_event#

def create_event(key: str, value: Any) -> Any

Saves an event in soil

create_alert#

def create_alert(alert: Dict) -> Any

Creates an alert

get_dictionary#

def get_dictionary(name: str, language: str) -> Dict[str, Any]

Get the a dictionary

create_dictionary#

def create_dictionary(name: str, language: str, content: Dict) -> Dict[str, Any]

Create a dictionary