Skip to content

Commit

Permalink
add bluesky-adaptive integration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ronpandolfi committed Jul 25, 2023
1 parent 495d50a commit a92b4a3
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/source/bluesky-adaptive.md
Original file line number Diff line number Diff line change
@@ -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
```
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,5 @@ quickstart.md
server_experiment.md
bluesky.md
api/index.md
bluesky-adaptive.md
```

0 comments on commit a92b4a3

Please sign in to comment.