regelum 0.2.2

Add your description here

regelum

regelum is a framework for modeling Phased Reactive Systems: systems that execute one tick at a time, activate different groups of nodes in different phases, and move between phases with explicit transitions.

Overview

• Nodes declare typed inputs and outputs.
• Phases decide which node instances are active together.
• Transitions describe how one phase hands control to the next.
• Compilation resolves links, schedules nodes, and catches structural mistakes before runtime.

The best entry point is the concepts overview:

• Docs: https://aidagroup.github.io/regelum/
• Concepts overview: https://aidagroup.github.io/regelum/concepts/

Quick Example

import regelum as rg


class TemperatureSensor(rg.Node):
    class Outputs(rg.NodeOutputs):
        temperature: float = rg.Output(initial=19.0)

    def run(self) -> Outputs:
        return self.Outputs(temperature=21.5)


class HeaterController(rg.Node):
    class Inputs(rg.NodeInputs):
        temperature: float = rg.Input(
            source=TemperatureSensor.Outputs.temperature,
        )

    class Outputs(rg.NodeOutputs):
        heater_on: bool

    def run(self, inputs: Inputs) -> Outputs:
        return self.Outputs(heater_on=inputs.temperature < 22.0)


sensor = TemperatureSensor(name="room_sensor")
controller = HeaterController(name="heater_controller")

system = rg.PhasedReactiveSystem(
    phases=[
        rg.Phase(
            "control",
            nodes=(sensor, controller),
            transitions=(rg.Goto(rg.terminate),),
            is_initial=True,
        ),
    ],
)

snapshot = system.step()
print(snapshot["heater_controller.heater_on"])

Installation

Recommended: use uv.

uv add regelum

For local development from this repository:

uv sync --all-groups
uv run pytest tests
uv run ty check src tests
uv run mkdocs serve

Examples

uv run regelum-pendulum
uv run regelum-video-player
uv run regelum-instance-connect

Release Process

Create a GitHub Release with a tag such as v0.2.0.

The publish workflow will:

1. build the package with uv build
2. derive version 0.2.0 from the git tag via hatch-vcs
3. publish the artifacts to PyPI with uv publish

After installation, users can verify the packaged version:

import regelum

print(regelum.__version__)