wei.core.storage

Handles all interactions with File storage/objects

Functions

get_experiment_directory(experiment_id[, ...])	Returns the directory for the given experiment id.
get_experiment_log_file(experiment_id[, ...])	Returns the log file for the given experiment id.
get_experiments_directory()	Returns the directory where the experiments are stored.
get_module_directory(alias[, data_directory])	Returns the directory for the given module.
get_workcell_directory(workcell_id)	Returns the directory for the given workcell name.
get_workcell_log_path(workcell_id)	Returns the log file for the given workcell id.
get_workflow_run_directory(workflow_run_id)	Returns the directory for the given workflow id.
get_workflow_run_log_path(workflow_run_id[, ...])	Returns the log file for the given workflow id.
initialize_storage()	Initializes the storage directories.
search_for_experiment_directory(experiment_id)	Searches for the directory for the given experiment id.

wei.core.storage.get_experiment_directory(experiment_id: str, experiment_name: str | None = None, create: bool = False) → Path

Returns the directory for the given experiment id.

wei.core.storage.get_experiment_log_file(experiment_id: str, experiment_name: str | None = None) → Path

Returns the log file for the given experiment id.

wei.core.storage.get_experiments_directory() → Path

Returns the directory where the experiments are stored.

wei.core.storage.get_module_directory(alias: str, data_directory: str | Path | None = None)

Returns the directory for the given module.

wei.core.storage.get_workcell_directory(workcell_id: str) → Path

Returns the directory for the given workcell name.

wei.core.storage.get_workcell_log_path(workcell_id: str) → Path

Returns the log file for the given workcell id.

wei.core.storage.get_workflow_run_directory(workflow_run_id: str, experiment_id: str | None = None, experiment_name: str | None = None, workflow_name: str | None = None) → Path

Returns the directory for the given workflow id.

wei.core.storage.get_workflow_run_log_path(workflow_run_id: str, workflow_name: str | None = None, experiment_id: str | None = None, experiment_name: str | None = None) → Path

Returns the log file for the given workflow id.

wei.core.storage.initialize_storage()

Initializes the storage directories.

wei.core.storage.search_for_experiment_directory(experiment_id: str) → Path

Searches for the directory for the given experiment id.