Skip to content

Add script execution docs and shortcut #436

Closed

Description

@Relm-Arrowny

Running script comes free with blueapi session so we should update the docs to show user how to run script.

Goals

Acceptance criteria : What journeys should the user be able to complete to consider your feature done
Be as specific as you can, check them off once they work. Add more if you find more requirements during development. Issue should only be considered done after all of them are checked

  • A user inside an interactive BlueAPISession shell can execute an external Python script (e.g., via run_script("my_scans.py") or %run -i my_scans.py) that has full access to session objects (pl, dev, bc, scan_data, plot).
  • A user can stack multiple sequential plan calls (pl.xxx()) alongside standard Python logic (loops, conditionals, data inspection on scan_data) in a script, with live plotting and data callbacks updating in real time during each scan.
  • Documentation in the BlueAPI Session tutorial explains how to write and run scan scripts both from inside the interactive shell and via the CLI.

Tasks

base on the goals, deduce the tasks required. check them off once they're done

  • Add a short cut for %run -i my_scans.py
  • Document how to make and run a script.
  • [ ]
  • [ ]
  • [ ]

Related Resources

scripting example:

Image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions