diff --git a/docs/source/bluesky-adaptive.md b/docs/source/bluesky-adaptive.md new file mode 100644 index 0000000..8275b22 --- /dev/null +++ b/docs/source/bluesky-adaptive.md @@ -0,0 +1,18 @@ +# Bluesky-Adaptive Integration + +[Bluesky-Adaptive](https://github.com/bluesky/bluesky-adaptive) is Bluesky companion package for tightly integrated +adaptive scans. Tsuchinoko may integrate with Bluesky-Adaptive by serving as the source of an `Agent`. + +Running Tsuchinoko with Bluesky-Adaptive requires a `TsuchinokoAgent` between the Tsuchinoko server and the Bluesky +RunEngine. The `TsuchinokoAgent` abstract base class provides a concise interface requiring the same components as a +Bluesky-Adaptive `Agent`. + +```{eval-rst} + +.. autoclass:: tsuchinoko.execution.bluesky_adaptive.BlueskyAdaptiveEngine + :members: + +.. autoclass:: tsuchinoko.execution.bluesky_adaptive.TsuchinokoAgent + :members: + :exclude-members: ask, tell +``` \ No newline at end of file diff --git a/docs/source/index.md b/docs/source/index.md index 58fb296..50fb663 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -60,4 +60,5 @@ quickstart.md server_experiment.md bluesky.md api/index.md +bluesky-adaptive.md ``` \ No newline at end of file