OP System¶
op_system
¶
op_system.
Domain-agnostic RHS specification + compilation utilities.
Public API (v1)¶
Primary user entrypoints:
- compile_spec: Validate, normalize, and compile a RHS specification in one step.
- normalize_rhs: Validate and normalize a YAML-friendly RHS specification.
- compile_rhs: Compile a NormalizedRhs into an efficient callable RHS.
Core data structures:
- NormalizedRhs
- CompiledRhs
- OperatorDescriptor
Design guarantees: - No dependency on provider/adapters (eg flepimop2). - Stable interface for downstream engines. - Forward-compatible with multiphysics extensions.
IdentifierString = Annotated[str, AfterValidator(_validate_identifier_string)]
module-attribute
¶
Custom pydantic type for validated identifier strings used in op_system.
Identifier strings are used for state names, dimension names, and other keys in the system. They must be non-empty, contain only alphanumeric characters, and start with a letter. Leading and trailing whitespace is stripped before validation.
Examples:
>>> from pydantic import BaseModel
>>> from op_system import IdentifierString
>>> class ExampleModel(BaseModel):
... identifier: IdentifierString
...
>>> ExampleModel(identifier="S")
ExampleModel(identifier='S')
>>> ExampleModel(identifier=" Foobar ")
ExampleModel(identifier='Foobar')
>>> ExampleModel(identifier="123abc")
Traceback (most recent call last):
...
pydantic_core._pydantic_core.ValidationError: 1 validation error for ExampleModel
identifier
Value error, IdentifierString must contain only alphanumerical characters and start with a letter. [...]
For further information visit ...
>>> ExampleModel(identifier="")
Traceback (most recent call last):
...
pydantic_core._pydantic_core.ValidationError: 1 validation error for ExampleModel
identifier
Value error, IdentifierString must not be empty. [...]
For further information visit ...
Array
¶
Bases: Protocol
Structural Array-API protocol.
Any object whose runtime type implements shape, dtype,
__array_namespace__ and item satisfies this protocol. NumPy
= 2.0 ndarrays, JAX arrays (concrete and traced), and PyTorch tensors (via the array-api compat layer) all qualify.
The namespace returned by __array_namespace__ is the only gate
op_system uses to dispatch operations: input → namespace → output in
that same namespace. No conversion, no coercion, no compile-time
backend selector.
BlockAxisInfo(name, size, state_axis_pos, param_axis_pos)
dataclass
¶
Metadata for one block-diagonal (factorizable) axis.
A BlockAxisInfo is attached to
:class:~op_system.compile.CompiledRhs for each axis declared in
spec["factorize_axes"] that passes the IR separability check in
:func:analyze_block_axes. Engines (e.g. the diffrax plugin) consume
this to partition ODE solves with jax.vmap over the block axis.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Axis name string (e.g. |
size |
int
|
Number of elements along the axis. |
state_axis_pos |
dict[str, int]
|
Maps each state-template base name to the integer position of this axis within that template's shape tuple. Only templates that carry this axis appear in the dict. |
param_axis_pos |
dict[str, int | None]
|
Maps each shaped parameter name to the integer
position of this axis within the actual runtime array that the
engine passes to the eval function, or |
Note
BlockAxisInfo uses dict fields and therefore cannot be used
as a hash key. It is stored on
:class:~op_system.compile.CompiledRhs with hash=False and is
fully pickle-stable.
Examples:
>>> info = BlockAxisInfo(
... name="loc",
... size=3,
... state_axis_pos={"S": 1, "I": 1, "R": 1},
... param_axis_pos={"rho": 0, "beta": None},
... )
>>> info.name
'loc'
>>> info.size
3
>>> info.state_axis_pos["S"]
1
>>> info.param_axis_pos["rho"]
0
>>> info.param_axis_pos["beta"] is None
True
BodyEvalFn
¶
Bases: Protocol
Callable that evaluates history signal bodies at (t, y, **params).
Returns a mapping from signal_id to the evaluated body array/value.
CompiledRhs(state_names, param_names, eval_fn, meta=(lambda: MappingProxyType({}))(), operators=tuple(), factorize_axes=tuple(), block_axes=tuple(), pytree_eval_fn=None, template_shapes=None, block_pytree_eval_fn=None, block_template_shapes=None, history_requirements=tuple(), history_eval_fn=None, body_eval_fn=None, block_history_eval_fn=None, block_body_eval_fn=None, _rhs=None)
dataclass
¶
Container for a compiled RHS evaluation function.
Instances produced by :func:compile_rhs retain a private reference to
their source :class:NormalizedRhs so the container can be pickled and
re-hydrated by re-running the compile pipeline on load. eval_fn
itself is a closure (and on the vectorized path captures compiled code
objects), so it is dropped from the pickle and rebuilt by
:func:compile_rhs in :meth:__setstate__. Round-tripping a
CompiledRhs therefore costs one compile on load and yields a
functionally equivalent instance whose eval_fn produces identical
outputs for identical inputs.
__getstate__()
¶
Return picklable state.
The compiled eval_fn is a closure (and on the vectorized path
captures compiled :class:types.CodeType objects), which is not
portably picklable. Instead we serialize just the source
:class:NormalizedRhs and let :meth:__setstate__ recompile.
Raises:
| Type | Description |
|---|---|
TypeError
|
If the source |
Source code in src/op_system/compile.py
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | |
__setstate__(state)
¶
Restore by recompiling from the pickled :class:NormalizedRhs.
Source code in src/op_system/compile.py
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | |
bind(params)
¶
Bind parameter values and return a 2-arg RHS: rhs(t, y) -> dydt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
Mapping[str, object]
|
Mapping of parameter names to values. |
required |
Returns:
| Type | Description |
|---|---|
Callable[[object, object], Float64Array]
|
A callable |
Source code in src/op_system/compile.py
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 | |
EvalFn
¶
Bases: Protocol
Callable RHS evaluator supporting runtime parameter kwargs.
Accepts a flat (n_state,) state array and returns a flat
(n_state,) derivative array in the same array namespace.
ExprRhs(state_names, equations, aliases, param_names, all_symbols, meta, state_templates=(), shaped_params=(), time_varying_params=(), aliases_ir=dict(), equations_ir=(), aliases_ir_reduce=dict(), equations_ir_reduce=(), alias_templates=())
dataclass
¶
Bases: _RhsBase
Normalized RHS for kind="expr" specs (explicit d(state)/dt equations).
Produced by :func:normalize_expr_rhs. Use :data:NormalizedRhs as the
union type when you need to accept both kinds.
ExpressionString(source)
dataclass
¶
Validated expression wrapper with cached AST and symbol names.
as_ir()
¶
Return the typed IR representation for this expression.
Returns:
| Type | Description |
|---|---|
Expr
|
Parsed typed IR tree. |
Source code in src/op_system/_symbols.py
43 44 45 46 47 48 49 | |
as_lowered_ir()
¶
Return helper-lowered typed IR for this expression.
Returns:
| Type | Description |
|---|---|
Expr
|
Typed IR tree with helper calls lowered to |
Source code in src/op_system/_symbols.py
51 52 53 54 55 56 57 | |
OperatorDescriptor(axis, kind=None, bc=None, velocity=None, rate=None, kernel=None)
dataclass
¶
Typed description of a spatial operator declared in an op_system RHS spec.
Captures the model-level description of an operator that is known at compile time: which axis it acts on, its kind (advection, diffusion, etc.), optional boundary condition, and the names of any runtime parameters (velocity, rate) it consumes. Grid geometry, CN matrix construction, and solver staging remain downstream concerns handled by the engine.
Attributes:
| Name | Type | Description |
|---|---|---|
axis |
str
|
Name of the axis the operator acts on (e.g. |
kind |
str | None
|
Operator type string, e.g. |
bc |
str | None
|
Boundary condition, e.g. |
velocity |
str | None
|
Parameter name for an advection velocity, or |
rate |
str | None
|
Parameter name for a diffusion rate/coefficient, or |
kernel |
Mapping[str, Any] | None
|
Mixing-kernel sub-specification, or |
Examples:
>>> od = OperatorDescriptor(axis="loc")
>>> od.axis
'loc'
>>> od.kind is None
True
>>> od.bc is None
True
>>> od.velocity is None
True
>>> od2 = OperatorDescriptor(
... axis="loc",
... kind="advection",
... bc="absorbing",
... velocity="v_advec",
... rate="diff_r",
... )
>>> od2.kind
'advection'
>>> od2.bc
'absorbing'
>>> od2.velocity
'v_advec'
>>> od2.rate
'diff_r'
PytreeEvalFn
¶
Bases: Protocol
Callable RHS evaluator operating on shaped PyTree state dicts.
Accepts y as a StateDict (mapping from state-template base name
to a shaped array with the template's natural N-D shape) and returns a
StateDict of the same structure containing the derivative.
Enables the engine to skip the flatten/unflatten step entirely and
expose the full tensor structure to JAX/XLA.
StateString
¶
Bases: BaseModel
Structured representation of a state string.
A state string is either a bare state name like "S" or a state name
followed immediately by bracketed dimensions like "R[age,vax]".
Examples:
>>> StateString.model_validate("S")
StateString(name='S', dims=())
>>> recovery = StateString.model_validate("R[age,vax]")
>>> recovery
StateString(name='R', dims=('age', 'vax'))
>>> print(recovery)
R[age,vax]
>>> recovery.model_dump()
'R[age,vax]'
>>> StateString.model_validate("Foobar[ age , vax ]")
StateString(name='Foobar', dims=('age', 'vax'))
__str__()
¶
Return the compact string form.
Returns:
| Type | Description |
|---|---|
str
|
Compact state string. |
Examples:
>>> str(StateString(name="S", dims=()))
'S'
>>> str(StateString(name="R", dims=("age",)))
'R[age]'
>>> str(StateString(name="R", dims=("age", "vax")))
'R[age,vax]'
>>> str(StateString(name="lambda", dims=("age", "vax", "state")))
'lambda[age,vax,state]'
Source code in src/op_system/_state_string.py
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | |
TransitionsRhs(state_names, equations, aliases, param_names, all_symbols, meta, state_templates=(), shaped_params=(), time_varying_params=(), aliases_ir=dict(), equations_ir=(), aliases_ir_reduce=dict(), equations_ir_reduce=(), alias_templates=())
dataclass
¶
Bases: _RhsBase
Normalized RHS for kind="transitions" specs (per-capita hazard diagram).
Produced by :func:normalize_transitions_rhs. Use :data:NormalizedRhs
as the union type when you need to accept both kinds.
compile_rhs(rhs, *, xp=None)
¶
Compile a normalized RHS into a runnable evaluation function.
Always uses the vectorized eval path that operates on shaped buffers
(one tensor expression per state template) for specs that declare axes.
Specs without axes (genuinely scalar models) fall back to the scalar path.
Raising :class:UnsupportedFeatureError if an axis-indexed spec cannot be
vectorized, rather than silently falling back to the catastrophically slow
scalar path.
The returned eval_fn is namespace-polymorphic: it infers its
array namespace from the input y at call time
(y.__array_namespace__()), and returns arrays in that same
namespace. Calling it with JAX arrays (or tracers) yields a JAX-native
computation suitable for jax.jit / jax.vmap without any
correctness wrapping.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rhs
|
NormalizedRhs
|
Normalized RHS produced by |
required |
xp
|
object | None
|
Deprecated. Formerly the compile-time array backend
namespace. Now ignored — the namespace is resolved per call
from the input |
None
|
Returns:
| Type | Description |
|---|---|
CompiledRhs
|
A |
CompiledRhs
|
For axis-indexed specs the returned object also carries |
CompiledRhs
|
|
CompiledRhs
|
axes but the vectorizer cannot build a plan an |
CompiledRhs
|
|
CompiledRhs
|
message) rather than silently degrading to the scalar path. |
Source code in src/op_system/compile.py
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 | |
compile_spec(spec, *, xp=None, backend=DEFAULT_ARRAY_BACKEND)
¶
Validate, normalize, and compile a RHS specification in one call.
This is the recommended public entrypoint for most users and adapters.
The compiled eval_fn is namespace-polymorphic: it infers its
array namespace from the input y at call time
(y.__array_namespace__()), so a single compiled callable handles
NumPy, JAX (concrete and traced), and any other Array-API backend
natively. No compile-time backend selection is required.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
spec
|
dict[str, object]
|
Raw RHS specification mapping (YAML/JSON friendly). |
required |
xp
|
object | None
|
Deprecated. Formerly the compile-time array backend
namespace. Now ignored — see |
None
|
backend
|
Literal['numpy', 'jax']
|
Deprecated. Formerly selected the compile-time
backend ( |
DEFAULT_ARRAY_BACKEND
|
Returns:
| Name | Type | Description |
|---|---|---|
CompiledRhs |
CompiledRhs
|
Runnable RHS callable container. |
Source code in src/op_system/__init__.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
normalize_expr_rhs(spec)
¶
Normalize an expression-based RHS specification.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
spec
|
Mapping[str, Any]
|
Raw RHS specification mapping. |
required |
Returns:
| Type | Description |
|---|---|
ExprRhs
|
Backend-facing normalized RHS representation. |
Raises:
| Type | Description |
|---|---|
InvalidRhsSpecError
|
If validation fails. |
Source code in src/op_system/_normalize.py
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 | |
normalize_rhs(spec)
¶
Normalize a RHS specification dict into a backend-facing representation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
spec
|
Mapping[str, Any] | None
|
Raw RHS specification mapping. |
required |
Returns:
| Type | Description |
|---|---|
NormalizedRhs
|
Backend-facing normalized RHS representation. |
Raises:
| Type | Description |
|---|---|
InvalidRhsSpecError
|
If validation fails. |
UnsupportedFeatureError
|
If validation fails. |
Source code in src/op_system/_normalize.py
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 | |
normalize_transitions_rhs(spec)
¶
Normalize a transition-based RHS specification (diagram/hazard semantics).
Returns:
| Type | Description |
|---|---|
TransitionsRhs
|
Backend-facing normalized RHS representation for the transitions kind. |
Raises:
| Type | Description |
|---|---|
InvalidRhsSpecError
|
If validation fails. |
Source code in src/op_system/_normalize.py
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 | |