Skip to content

v1.5.0

Latest

Choose a tag to compare

@github-actions github-actions released this 15 Nov 05:33
5ad3f97

1.5.0 (2026-11-15)

Highlights

  • System analysis: bd.functions() turns a block diagram into the functions f(x,u) and g(x,u), and bd.linearize() gives the A, B, C, D matrices and poles at an operating point; Linearization.ss() hands the result to python-control
  • Type checking: every wire has a signature recorded at compile time, source blocks emit one type, and the run-time checks catch an output that changes type
  • New blocks: STATE, STATE_S, SWITCH, SQRT, SIGN, ABS, DEADBAND, HYSTERESIS_S, ANOISE_S and MNOISE_S
  • Event handling for discontinuous blocks: zero-crossing events for INTEGRATOR limits and enable, and for CLIP, DEADBAND, SIGN, ABS and SWITCH, so the simulation lands on the discontinuity
  • Block parameters: one registry (Block.set_param, parameters(), --set and --param) with type enforcement, and subsystems forward their parameters to the blocks inside
  • Subsystem INPORT and OUTPORT blocks are replaced by wires, which fixes #84
  • A complete set of notebooks for classic control problems: Furuta pendulum, ball and beam, cart and pole, coupled tanks, temperature control, and system analysis; and an index with tags

Behaviour change

  • A list of numbers is now an ndarray by default, with asarray=False to opt out

Features

  • --npz writes the results as a NumPy archive (#154) (6ee2a19)
  • a list of numbers becomes an ndarray by default, with asarray=False to opt out (dd55a75)
  • a list of numbers becomes an ndarray by default; asarray=False to opt out (93bef9d)
  • add ANOISE_S and MNOISE_S, clocked additive and multiplicative noise blocks (#184) (8786f82)
  • add bd.functions() and bd.linearize() (#202) (0e346a2)
  • add HYSTERESIS_S, a discrete-time hysteresis (relay with memory) block (#182) (6508400)
  • add icons for SWITCH and the blocks that had none (#188) (dc7c472)
  • add icons for the new function, hysteresis and noise blocks (#186) (6f33dce)
  • add Sqrt, Sign, Abs and Deadband function blocks (#178) (e89e173)
  • add SWITCH, a block that selects one of two signals (#187) (f22fc56)
  • add the Block.configure() hook, run once per run before start() (70656dc)
  • add the STATE and STATE_S blocks (#204) (8f3a271)
  • ANIMATION takes projection="3d" to give init 3D axes (#246) (c1555fd), closes #245
  • BDSim.run takes the per-run options as keyword arguments (#233) (819c92f)
  • block parameters: one registry, type enforcement, --set and --param (dee08f6)
  • block parameters: one registry, type enforcement, --set and --param (4c64920)
  • initial states are parameters, and --set is applied before they are collected (4646bf2)
  • Linearization.ss() returns a python-control state-space system (#209) (6d94000)
  • NumPy dtype literals for parameters given as text, float32([1, 2]) (#157) (8a04025)
  • NumPy dtype literals for parameters given as text: float32([1, 2]), uint16(5) (8a04025)
  • one switch for the run-time checks, and a check for change of signature (c6de015)
  • one switch for the run-time checks, and a check for change of signature (615a924)
  • PID and PID_S take terms= to say which terms to build; fixes pure P (#163) (b4b5f01)
  • properties and forwarding for every block parameter (f5b58c3)
  • properties for the parameters of single blocks with derived state (4b0def1)
  • record the signature of every wire at compile time (6eb8240)
  • record wire signatures at compile time; Block.configure(); reset() restores block state (dea411d)
  • replace subsystem INPORT/OUTPORT blocks by wires (fixes #84) (32a259f)
  • replace the INPORT and OUTPORT blocks of a subsystem by wires (#84) (ed7e5fe)
  • report_summary(implicit=False) hides implicit blocks, which sort last (#230) (1f981eb)
  • source blocks emit one type, checked when the block is created (6cccba5)
  • source blocks emit one type, checked when the block is created (a390432)
  • stubgen --check, --package and --out; BlockFactoryStubs and toolbox stub snapshots (#196) (8ea3036)
  • subsystem blocks forward their parameters to the blocks inside (1695667)
  • the notebooks get their install cell from one shared template (#241) (1faff2f)
  • write LTI_SS_S in Phi and Gamma, add them as attributes, and correct its docstring (#191) (92f171b)
  • zero-crossing events for INTEGRATOR limits and enable, and CLIP corners (#180) (f7d7de7)

Bug Fixes

  • a crossing event with a fixed output grid restarts at the event time (#159) (e95592b)
  • annotate LTI_SS x0 as Vector1D (#177) (a7304c6)
  • annotate LTI_SS x0 as Vector1D, as documented and as subclasses pass it (a7304c6)
  • attach the examples and notebooks zips to releases made by release-please (#236) (54e217f)
  • avoid endless repainting when setting background brush in bdedit (#145) (b6e23a0)
  • bdedit: render the screenshot region for PNG export (#142) (0d51208)
  • BlockDiagram.ls() no longer loops forever (#200) (40883c8)
  • bound the number of frames of a live animation, and report them (#215) (9b5a180)
  • give subsystem instances unique default names, and stop defaulting the diagram name to "main" (0540805)
  • Linearization.poles is real when all the poles are real (5bb3cab)
  • Linearization.ss() replaces a dot in a signal name with an underscore (#242) (fa97040)
  • LTI_SS and LTI_SS_S with several rows in C have one output port (#210) (fd47aab)
  • name the discrete states consistently, clock by clock (#211) (89a15be)
  • notebook animations drew 13-40% fewer frames than animation_rate asked for (#248) (38908f9)
  • notebook ARMPLOT asks the block to move the robot plot (#254) (ed00426)
  • recompute the state at a crossing from the start of its step (#181) (a63c372)
  • SCOPE no longer modifies the style dict it is given, and honors a line width in it (#192) (dd632db)
  • Scope no longer passes the line style to matplotlib as its label (#147) (ea5084a)
  • Slice1 accepts an integer index as documented; drop a debug print in Function.start (af9202b)
  • unique default names for subsystem instances; diagram name defaults to None (#148) (0540805)

Documentation

  • add the cart-pole, linearization and temperature-control-lab notebooks, and tidy the first cells (#235) (5ece739)
  • ask to be assigned, and wait, before starting on an issue (#239) (973c9b6)
  • centre the tag capsules on the line of text in the notebook index (#252) (8821e1e)
  • correct the LTI_SS and PID_S docstrings (#190) (92cef0a)
  • correct the Pow matrix and Scope scale parameter descriptions (c0e7adc)
  • document the attributes of Linearization, SystemFunctions and Index (#208) (214cc26)
  • host the Furuta pendulum photo in the repository (#253) (b9dccca)
  • notebook polish, the analysis, Furuta, ball-beam and two-tanks notebooks, and index tags (5bb3cab)
  • resolve the cross-references Sphinx dropped, and report them from now on (#238) (495a8a9)
  • say that supported Python versions are those in the pyproject classifiers (#173) (b01dab2)
  • sidebar, Developer API, installation extras and docstring fixes (#214) (a369504)
  • state the timing of sampled blocks; fix the ZOH and DERIV_S docstrings (#183) (5f9a017)
  • write LTI_SS_S in Phi and Gamma, add them as attributes, and correct the docstring (92f171b)

Build System

  • add mypy checks and typed wheel metadata (#143) (04d09e7)