Skip to content

Commit 3c9d80d

Browse files
committed
Add comment on instrument sessions to scripting docs
1 parent f752763 commit 3c9d80d

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/tutorials/scripting-plans.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,14 @@ Trying to access a child device that does not exist will raise an
6464

6565
## Run a plan
6666

67+
Running plans requires an instrument session. As this is unlikely to change from
68+
one plan to another, this can be set on the client to be used for all subsequent
69+
plans.
70+
71+
```python
72+
bc.instrument_session = "cm12345-1"
73+
```
74+
6775
Plans are accessible via the `plans` attribute of the client instance. They can,
6876
for the most part, be treated as if they were local functions.
6977

0 commit comments

Comments
 (0)