How-to Guides¶
Each guide walks you through one task, step by step. If you're new to
redsun, the tutorials are a better place to start.
Install¶
Build a session¶
Write the parts of a session and put them together.
- How to write a component
- How to write a service
- How to write a camera for continuous acquisition
- How to write a session file
- How to wire components together
- How to offer a pairing
- How to share a value between components
- How to package components as a plugin
- How to test a plugin
- How to connect a device on demand
- How to serve a FastCS controller over sharedbox
Write plans¶
Offer plans, run them, and show their controls and progress.
- How to run a plan from a presenter
- How to choose the inputs of a plan
- How to write a plan that runs until stopped
- How to follow a plan action from a view
- How to show a plan's progress
Use the built-in components¶
Add the presenters and views redsun ships, instead of writing your own.
Extend the window¶
Change what a Qt session shows, without changing what it builds.
- How to place a view in the window
- How to write a frontend
- How to install hooks
- How to choose a style
- How to add menu actions to a Qt session
- How to add keyboard shortcuts
Run a session¶
Run a session, follow what it does and keep its settings.
- How to run a session without a GUI
- How to run a session without hardware
- How to find out why a component is missing
- How to configure logging
- How to profile a session
- How to change a device setting while a plan runs
- How to save a session
Store data¶
Choose where acquisition files go, keep a catalog of runs, and write what you compute from them.
- How to choose where acquisition files go
- How to keep a catalog of runs
- How to write a derived product
Upgrade¶
Move code written for an earlier release to this one.
Contribute¶
The guides for changing redsun itself have a section of their own,
Contributing.