redsun
A component-based, customizable application framework for scientific hardware orchestration, based on the Bluesky framework.
To learn redsun, start with the tutorials. They build one application step by step, and need no hardware.
Problem statement
In scientific research involving device control, one of the major problems is orchestrating different hardware units to achieve reusable, reliable and documentable workflows. On top of that, such hardware orchestration should provide a coherent and understandable user interface that less technical inclined users are able to understand and leverage accurately.
This proves challenging, because making experiments is a fluid endevour. It's hard (next to impossible) to predict what are the actual final requirements a software should encapsulate, especially if the final output is to face this to scientists with no engineering background.
Rather than trying to ship an entire software on its own, redsun follows the idea of component-based development: ship off-the-shelf components, assemble and wire them depending on the needs.
Component-based development (CBD)
In CBD, interfaces are key. Each component express what it requires to be built, as well as offering functionalities that can be leveraged by other components.
Components are put together in a session, which builds the application for you, so you can focus on what each component does.
from collections.abc import Iterator
from typing import Annotated
from mylab.devices import MyMotor
from mylab.presenters import MyController
from mylab.views import MyView
from redsun import AsDevice, AsPresenter, AsView, Declare, Link
from redsun.qt import QtSession
class MyApp(QtSession):
stage: Annotated[AsDevice[MyMotor], Declare(axis=["X", "Y"], egu="mm")]
ctrl: Annotated[AsPresenter[MyController], Declare(timeout=2.0)]
panel: AsView[MyView]
def wire(self) -> Iterator[Link]:
yield self.ctrl.sig_position_changed, self.panel.update_position
MyApp({"session": "my-session"}).run()
Each component is declared once, with the arguments it needs. wire says which signal reaches which slot; the session builds everything in order and connects it.
redsun provides the common glue code that each component can use to ship entire applications or single, reusable components. Leveraging Python entry points, an application can also be shipped as a single YAML configuration file, provided that different contributing components expose a redsun.yaml manifest.
So the same application can be expressed as:
# session.yaml
schema_version: 1.0
frontend: qt
session: my-session
devices:
stage:
plugin_name: mylab
plugin_id: my_motor
axis: ["X", "Y"]
egu: mm
presenters:
ctrl:
plugin_name: mylab
plugin_id: my_controller
timeout: 2.0
views:
panel:
plugin_name: mylab
plugin_id: my_view
wiring:
ctrl.sig_position_changed: panel.update_position
plugin_id is resolved through the manifest the contributing package ships:
# mylab/redsun.yaml
devices:
my_motor: mylab.devices:MyMotor
presenters:
my_controller: mylab.presenters:MyController
views:
my_view: mylab.views:MyView
Launch it with:
from redsun import Session
Session.from_config("session.yaml").run()
Session architecture
Each redsun session is structured as a Device-View-Presenter (DVP) application. This resembles the Model-View-Presenter (MVP) architecture, with the difference that at the lower level of the application sits the Device layer, leveraging ophyd-async, to interact with hardware components.
This is to make a clear statement: redsun is primarely about device control, and tries to do it well.
Documentation
See the documentation for more informations.
License
redsun is released under license Apache 2.0.
See the license for further details.
1 maintainer
Metadata
1 maintainer
Release files for redsun 0.14.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| redsun-0.14.1.tar.gz | 136.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| redsun-0.14.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 301.8 kB
Release files / redsun-0.14.1.tar.gz
| Download URL | redsun-0.14.1.tar.gz |
|---|---|
| Size | 136.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ff79e280cc11c1ad500620d80f68681b667ef1d8cef05f254b82836cb5948f78
|
|
BLAKE2b-256 checksum How to use checksums |
c08b1040e7578937fce7502035f86704b1cd8371e9f266414044cd76f7ad22d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.
Transparency logRelease files / redsun-0.14.1-py3-none-any.whl
| Download URL | redsun-0.14.1-py3-none-any.whl |
|---|---|
| Size | 165.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
46015ada3a57eb22266af801f1aad38676564a9581ea5533bc41a85555f19cc0
|
|
BLAKE2b-256 checksum How to use checksums |
99f818e9444f9eed60bfb1ae33b6bd9138ba7bbc2984bdcf6e908e80cd4e9dcf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.
Transparency log
