regelum
regelum is a framework for designing and simulating dynamic systems, feedback
loops, DAGs, and dataflows as Phased Reactive Systems (PRS). A PRS has two
levels of abstraction: low-level computational primitives called nodes, and
high-level execution stages called phases. Nodes declare Inputs for values
read from other nodes or system sources and State for values they own and
publish; phases group node instances into executable slices, resolve their
dependency graph, and move execution through explicit transitions. These
transitions can be unconditional or conditional, so execution can branch to
different phases depending on current system state.
The API is intentionally built from Python's own language features: type annotations, nested classes, descriptors, declarative function signatures, operator overloading, and ordinary Python objects. It is inspired by frameworks such as FastAPI, Typer, Pydantic, SQLModel, SQLAlchemy, and FastStream. The goal is to make system models look like regular Python while still giving the compiler enough structure to resolve dependencies, validate the graph, schedule execution, and integrate continuous dynamics.
The best entry point is the Learn overview:
- Docs: https://aidagroup.github.io/regelum/
- Learn overview: https://aidagroup.github.io/regelum/latest/concepts/
Quick Example
import random
import regelum as rg
class TemperatureSensor(rg.Node):
class State(rg.NodeState):
temperature: float
def update(self) -> State:
return self.State(temperature=round(random.uniform(18.0, 26.0), 1))
class HeaterController(rg.Node):
class Inputs(rg.NodeInputs):
temperature: float = rg.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 State(rg.NodeState):
count: int = rg.var(init=0)
def update(
self,
prev_state: State,
is_heater_on: bool = rg.src(HeaterController.State.heater_on),
) -> State:
return self.State(
count=prev_state.count + int(is_heater_on),
)
sensor = TemperatureSensor()
controller = HeaterController()
cycles = HeatingCycles()
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 mkdocs serve
Citation
If you use regelum in academic work, please cite it using the metadata in
CITATION.cff.
License
regelum is distributed under the MIT License. See LICENSE.
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.
Metadata
Release files for regelum 0.4.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 | Provenance | Actions |
|---|---|---|---|---|
| regelum-0.4.1.tar.gz | 31.4 kB | Without provenance | Details for regelum-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| regelum-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for regelum-0.4.1-py3-none-any.whl |
Total release size: 66.0 kB
Release files / regelum-0.4.1.tar.gz
| Download URL | regelum-0.4.1.tar.gz |
|---|---|
| Size | 31.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2fa40bf63a4dd48ae54d8f6507c2c718e9865e56c690c978971e6eaf153a7ee9
|
|
BLAKE2b-256 checksum How to use checksums |
c00a854b9a3b4d8235eca8467fab6255876f4c46bca79775047ebbae94cfe46a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / regelum-0.4.1-py3-none-any.whl
| Download URL | regelum-0.4.1-py3-none-any.whl |
|---|---|
| Size | 34.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0a72a610df000960ca65dd18868083b95d4dd41ddeb4a156e46bd5021d56af9e
|
|
BLAKE2b-256 checksum How to use checksums |
c505d43cf1be2fde120bfbe4732f3e25238292f3ebed3798e79fa8e08b89ae77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for regelum 0.4.1
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
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.