bluesky.plan_stubs.close_run#
- bluesky.plan_stubs.close_run(exit_status: str | None = None, reason: str | None = None) Generator[Msg, Any, str][source]#
Mark the end of the current ‘run’. Emit a RunStop document.
- Parameters:
- exit_status{None, ‘success’, ‘abort’, ‘fail’}
The exit status to report in the Stop document
- reasonstr, optional
Long-form description of why the run ended
- Returns:
- uuid
Unique ID for the run
- Yields:
- msgMsg
Msg(‘close_run’)
See also
bluesky.plans_stubs.open_run()