Repository navigation
Release notes for sbmlsim 0.29.0
A fourth simulation engine: Simulator(engine="core") runs a model on the Rust SBML engine of sbmlsim-core, compiled to WebAssembly, next to roadrunner, COPASI and AMICI. It needs no extra, since sbmlsim-core is already a dependency of sbmlsim, runs the points of a scan on threads of the engine instead of in worker processes and agrees with roadrunner the most closely of the three other engines. The new page Benchmarks measures what a load, a simulation and a scan cost in each of the four engines. The default app of a model shows every variant with its own panels where they differ.
Features
- The engine core (#539).
Simulator(engine="core"):CoreSBMLModel(model/model_core.py) compiles the SBML into a WebAssembly module, kept per SBML and compile options, on a runtime created once per process;simulator/executor_core.pywrites a plan as one request of the contractsimulation/1, which the engine simulates with the semantics of the executor of roadrunner. A scan hands the requests of a chunk to the engine as one batch on its own threads (at mostCORE_MAX_CHUNK, 250 points), so a run of the engine core starts no worker processes. The integrator is CVODE with the vector of absolute tolerances roadrunner computes per state, so the engine agrees with roadrunner to2.4e-11relative on the HCTZ model at tight tolerances, against1.6e-8for COPASI and AMICI; it is a build of CVODE of its own, so its results are not roadrunner's bitwise, and the module docstring lists the known differences. The engine joins the tests of the engines, the cross simulator of the battery of the credibility and the provenance and the methods of a fit. Until sbmlsim-core#7 is released, a pre-initialization which sets the concentration of a species and changes the size of its compartment is refused. - Benchmarks of the engines (#539).
docs/benchmarks.md: the load, the compilation, one simulation and a scan of 1000 points, serial and on 8 workers, of the four packaged models in every engine, with the agreement with roadrunner, measured withscripts/engine_benchmark.pyon pinned cores, cold against warm and over the width of the output grid. - The default panels of a variant (#540).
Project.default_variant_panels(panels, variants)gives the panels of the variants which show the panels ofProject.default_appotherwise, from those panels and the SBML the factory wrote for every variant, none by default; the web assets set them asvariant_panelsof the project of the app. pkpdsim gives the build of each sex the classes of a renal impairment at its own healthy GFR.
Documentation
- The engine core wherever the documentation names the engines (#543): the introduction and the README, the API pages
model.model_coreandsimulator.executor_core, and the comparison of the engines in Simulations, which runs roadrunner, COPASI and the engine core and shows the agreement of each with roadrunner.
Changes
- The job
core engineof the continuous integration goes, since the test matrix covers the engine from the lock (#542).