-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add bluesky-adaptive integration docs
- Loading branch information
1 parent
495d50a
commit a92b4a3
Showing
2 changed files
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -60,4 +60,5 @@ quickstart.md | |
server_experiment.md | ||
bluesky.md | ||
api/index.md | ||
bluesky-adaptive.md | ||
``` |