Skip to main content

PyPI PyPI - Python Version PyPI - Status License CI codecov Documentation uv Ruff Checked with mypy Conventional Commits

redsun

redsun is a Python toolkit for building your own modular software for scientific data acquisition. It builds on the Bluesky ecosystem and makes no assumptions about your hardware, so each lab can build the control software its experiments need.

To learn redsun, start with the tutorials, where you build one application step by step without any hardware.

Problem statement

When research depends on controlling hardware, one of the hardest problems is making different instruments work together in workflows that are reusable, reliable and documented. On top of that, the software needs an interface that people with less technical background can understand and use correctly.

That's hard because experiments keep changing. It's next to impossible to predict everything the software will finally need to do, especially when the people using it are scientists with no engineering background.

So rather than shipping one complete program, redsun follows the idea of component-based development: it ships ready-made components, and you assemble and wire them for what you need.

Component-based development (CBD)

In component-based development, what matters most is the interface of each component. A component says what it needs to be built, and offers features that other components can use.

You put components 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()

You declare each component once, with the arguments it needs, and wire says which signal reaches which slot. The session then builds everything in order and connects it.

redsun provides the shared code that connects components, so you can use it to ship a whole application or a single reusable component. Through Python entry points, you can also ship an application as a single YAML configuration file, as long as each package that contributes components includes a redsun.yaml manifest.

The same application then looks like this:

# 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

The session looks up each plugin_id in the manifest that 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 a Device-View-Presenter (DVP) application. DVP resembles the Model-View-Presenter (MVP) architecture, except that the bottom layer of the application is the Device layer, which uses ophyd-async to talk to the hardware.

This design makes a clear point: redsun is first of all about device control, and tries to do it well.

Documentation

The documentation covers everything else.

License

redsun is released under the Apache 2.0 license. See the license for the full text.

Metadata

Release files for redsun 0.15.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for redsun 0.15.0
File Size Uploaded Provenance
redsun-0.15.0.tar.gz 267.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for redsun 0.15.0
File Interpreter ABI Platform
redsun-0.15.0-py3-none-any.whl Python 3 none any Details

Total release size: 625.9 kB

Release files / redsun-0.15.0.tar.gz

Download URL redsun-0.15.0.tar.gz
Size 267.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e13feec80c70b9ba5bdd729f0e769d419a7db7e00c7b3afb6da776d2475071aa
BLAKE2b-256 checksum
How to use checksums
d9e567d817497e29592e203035691c0b5400cc3fdd0d61ebb14c1ed7c9855006
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 23, 2026.

Transparency log

Release files / redsun-0.15.0-py3-none-any.whl

Download URL redsun-0.15.0-py3-none-any.whl
Size 358.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f42c6fbc8b7b5115f3c7bf0444e864459b7b2ec76014fe9e93f2beb357b599dc
BLAKE2b-256 checksum
How to use checksums
cbfa8095bee283c29e433c64c1b68aa0fb94963e6356455e08a00700c4911b87
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 23, 2026.

Transparency log

Security for redsun 0.15.0

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for redsun-0.15.0.tar.gz

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 Oct 23, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.15.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page