regelum 0.3.1

Add your description here

regelum

regelum is a framework for prototyping and simulating dynamic systems and general dataflows. It introduces Phased Reactive Systems (PRS): systems that execute one tick at a time, activate different groups of nodes in different phases, and move between phases with explicit transitions.

Any algorithm written with regelum can be decomposed into a graph of phases with conditional transitions. Each phase is represented as a DAG of computational primitives called nodes: stateful computation units with two namespaces, Inputs and State. A state variable written by one node can be used as an input of another node, while a node can also read its own previous state directly in update.

regelum deliberately leans on Python syntax sugar. The API is inspired by frameworks such as FastAPI, Typer, Pydantic, SQLModel, SQLAlchemy, FastStream, and others that made Python annotations, descriptors, nested classes, and declarative function signatures into compact framework DSLs. In regelum, Node, State, Var, Input(src=...), and update(...) provide a concise way to write computation nodes while the built-in compiler/resolver derives the execution order and validates the graph.

Overview

• Nodes declare typed inputs and state variables, then compute their next state in update.
• Phases decide which node instances are active together and how control moves between phases.
• Continuous nodes declare ODE state and are integrated through ODESystem phases.
• Compilation resolves links, schedules nodes, and catches structural mistakes before runtime: unresolved inputs, ambiguous references, invalid phase graphs, and computations that cannot be guaranteed to resolve.

The best entry point is the Learn overview:

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

Quick Example

import regelum as rg


class TemperatureSensor(rg.Node):
    class State(rg.NodeState):
        temperature: float = rg.Var(init=19.0)

    def update(self) -> State:
        return self.State(temperature=21.5)


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

    class State(rg.NodeState):
        heater_on: bool

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


class HeatingCycles(rg.Node):
    class Inputs(rg.NodeInputs):
        heater_on: bool = rg.Input(src=HeaterController.State.heater_on)

    class State(rg.NodeState):
        count: int = rg.Var(init=0)

    def update(self, inputs: Inputs, prev_state: State) -> State:
        return self.State(
            count=prev_state.count + int(inputs.heater_on),
        )


sensor = TemperatureSensor(name="room_sensor")
controller = HeaterController(name="heater_controller")
cycles = HeatingCycles(name="heating_cycles")

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

system.step()
print(system.read(controller.State.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 tagged like v0.2.0. The publish workflow builds the package, derives the version from the tag, and uploads artifacts to PyPI.

After installation, users can verify the packaged version:

import regelum

print(regelum.__version__)