Skip to content

Commit 4525485

Browse files
authored
Merge branch 'main' into dependabot/pip/ophyd-async-ca--0.14.0
2 parents f882ae9 + 8469723 commit 4525485

File tree

4 files changed

+16
-1
lines changed

4 files changed

+16
-1
lines changed

doc/dev/troubleshooting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
## Where is ...?
77

8+
{#where_are_plans_devices}
89
### Instrument-specific plans & devices
910

1011
This is located in each instrument's `inst` script area, with their other instrument-specific scripts.

doc/plans/plans.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# General Plans
1+
# General Plans
2+
3+
:::{note}
4+
{ref}`Instrument-specific bluesky plans <where_are_plans_devices>` are defined in each instrument's `inst` scripts area.
5+
This page documents general cross-instrument plans provided within the {py:obj}`ibex_bluesky_core` library.
6+
:::
27

38
The {py:obj}`ibex_bluesky_core.plans` module provides a number of plans that can be run by the RunEngine directly. These are mostly wrappers around the generic {external+bluesky:doc}`bluesky plans <plans>`.
49

doc/plans/reflectometry.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Reflectometry-specific Plans
22

3+
:::{note}
4+
{ref}`Instrument-specific bluesky plans <where_are_plans_devices>` are defined in each instrument's `inst` scripts area.
5+
This page documents general cross-instrument plans provided within the {py:obj}`ibex_bluesky_core` library.
6+
:::
7+
38
These are plans that are only expected to be useful on Reflectometry beamlines.
49

510
```{toctree}

doc/tutorial/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ def plan():
4242
yield from bps.null()
4343
```
4444

45+
{ref}`Instrument-specific bluesky plans <where_are_plans_devices>` are defined in each instrument's `inst` scripts area.
46+
4547
## Devices
4648

4749
The {py:obj}`ibex_bluesky_core.devices` module provides built-in support for a number of ISIS-specific devices. For example,
@@ -60,6 +62,8 @@ Block objects provide several mechanisms for configuring write behaviour; see
6062
Likewise, the DAE is available as a bluesky device: see [the DAE Documentation](../devices/dae.md)
6163
for full examples including example configurations.
6264

65+
{ref}`Instrument-specific bluesky device instances <where_are_plans_devices>` are defined in each instrument's `inst` scripts area.
66+
6367
## Setting and reading values
6468

6569
Bluesky provides plan stubs for setting & reading values from bluesky devices: `bps.mv()` and

0 commit comments

Comments
 (0)