soil.api

This package contains calls to the SOIL's REST API

upload_data#

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

Upload data to the cloud as a new dataset.

get_result#

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

Get the result data

get_result_data#

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

Get the result data

upload_module#

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

Uploads a module

get_module#

get_module(full_name: str) -> GetModule

Downloads a module

set_alias#

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#

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

Gets an alias

create_experiment#

create_experiment(plan: Plan) -> Experiment

Runs an experiment in SOIL

get_experiment#

get_experiment(experiment_id: str) -> Experiment

Runs an experiment from SOIL

get_experiment_logs#

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

Gets logs from a SOIL experiment

create_event#

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

Saves an event in soil

create_alert#

create_alert(alert: Dict) -> Any

Creates an alert