pcdsutils.ext_scripts.get_current_experiment

pcdsutils.ext_scripts.get_current_experiment(hutch: str | None = None, live: bool = False, timeout: float = 1.0)[source]

Call get_curr_exp to return the current experiment name.

Parameters:
hutchstr, optional

The name of the hutch to get the experiment for. If omitted, the hutch name will be determined automatically via cli argument.

livebool, optional

Defaults to False. If True, we’ll return the experiment of the current run.

timeoutint or float, optional

Time to wait for get_curr_exp to finish. Defaults to a 1 second timeout.

Returns:
experiment_namestr