Skip to content

0.34.0

Latest

Choose a tag to compare

@github-actions github-actions released this 20 Nov 11:13
· 1 commit to develop since this release
e5560c2

Release notes for sbmlsim 0.34.0

sbmlsim

The web app of a model is a dashboard: a page whose panels are picked by the figure of the model draws them as plots rather than as cards, a simulation is frozen and compared with the live one, and the app is as wide as the screen it is read on. panels_from_figure takes the knobs of the page its panels belong to, so the panels of a figure are declarable without being built a second time.

Features

  • The panels of a figure take the knobs of their page (#587). panels_from_figure took the simulation every panel runs and not the knobs, which is incoherent for the simulation it is given: a formula of a derived target (PanelSimulation.derived) reads the knobs of its panel, so a panel which runs such a simulation and carries no knobs is refused when the service registers its model, with a formula which reads what is no knob of its panel. Every consumer answered it the same way, by rebuilding with Panel.model_validate every panel the function had just built. The new keyword knobs puts them on every panel of every part of a key; the default is the empty tuple, so a caller whose simulation has no derived targets is unaffected. The knobs belong to the page and not to the drawing: the shell of a page offers one control per knob id and sets every panel of the page from it.

    Two things the docstring left to the caller are written down with it. The ids of the panels are the ones of the readouts sidecar, which is written without compiling a model, so the panels are a proposal: they are declarable only once restrict_to_model has dropped what the compiled model does not have, and skipping that step is an error of the registry and not a cosmetic one. The label of a curve is the one of the sidecar unless the grouping answers another, and it is drawn in the legend of the panel, beside the title and not instead of it, so a label which repeats the title is read twice and fits once. Shortening it stays with the package which writes the labels, through the grouping hook: the short name of a substance is the vocabulary of that package.

  • A page driven by a figure is a dashboard (#586). The vendored renderer is sbmlsim-web 0.6.0. A panel of a page which carries a figure is a plot: no line of the run, no reset and no logarithmic toggle, so twelve readouts of a part of the body are read at a glance instead of as twelve cards. Clear selection drops the panels the figure selected, and Freeze keeps the current simulation and draws it dashed beside the live one, up to four of them, each labelled with the state of the knobs it was run at, so the effect of a dose, a body weight or a renal function is compared in the plot rather than remembered between runs. A chip drops one frozen run and Drop all drops them all. The comparison controls are a line of their own at every width, so a control which comes and goes, the draws of a model without uncertainty, never moves the page while its panels load.

  • The page of an app is as wide as the screen, a page of panels keeps its reading width (#586). An app draws the figure of its model beside its panels, which is worth the width of a screen, so such a page is 1920 px wide; a page of panels alone keeps the reading width of 1216 px it had.

Fixes

  • The notices of the components are read where a reader looks for them (#586). The notices of the engine and of the renderer were a markdown table written into a <pre>, which a browser shows as its source text, with the pipes and the dashes of the table, and they sat in the footer of the page, which an app does not show. They are plain text now, a block per row of the table, so a notice reads at the width of a panel without a horizontal scrollbar:

    SUNDIALS (CVODES, IDA and their vectors, matrices and linear solvers)
      Version: 7.9.0
      Submodule and commit: third_party/sundials, tag v7.9.0, commit 312fc0f
      License: BSD-3-Clause
    

    An app carries them in its information view through the slot licenses, under a heading per component, and a page of panels keeps them in its footer; a page is checked for carrying its licenses exactly once and in the place its kind has.

  • A frozen run never pushes a legend entry out of its plot (#586, sbmlsim-web #13). The figure of a panel reserved the room of its legend for the entries of its curves and of the legends it may show, but not for the entries of the frozen runs, so a card at the size of a dashboard panel drew the last entry one pixel below its lower edge once a run was frozen. The frozen entries are part of every legend the figure plans for.