All notable changes to PyBNF are documented below. This project adheres to Keep a Changelog conventions.
job_type = msno longer dies on a fit with a measurement-model formula observable (#578). Multiple shooting was unusable on essentially the whole PEtab-imported corpus — including its own motivating problem,Borghans_BiophysChem1997— failing on the first outer iteration withMeasurement model 'Ca' would shadow an existing simulation-output column. The setup was all correct (noise profiling, the4-2-1ladder, knot placement); it died the moment the loop asked for a second evaluation. The measurement layer materializes eachobservable: <id>, formula: ...column into the trajectory in place (ADR-0036) and deliberately refuses a column that already exists. Every ordinary fit satisfies that for free, because the propose/score loop scores a freshly simulatedDataevery time. Multiple shooting caches its segment trajectories per point — so that one augmented-model evaluation costs one pass of segment simulations rather than two — and the outer loop then re-evaluates at the point the inner solver finished at, which is a cache hit on those very objects. Fixed at the cause: the assembled objective is now memoized on the point, so each simulated trajectory is scored exactly once. That also removes a redundant gradient/Fisher assembly per outer iteration, the larger of the two costs. Sound because the objective at a point does not depend on the multipliers — only the augmented model combines them. The shooting suite structurally could not see this: its fixtures score native columns (a species, an observable), so the measurement layer never ran. The regression tests use a formula-observable fixture, and both fail with the exact production error when the memo is removed.job_type = checkruns again (#569). #564's method-chain record was built fromalg.res_diron a line that ran before thejob_type != 'check'branch nine lines below it, so every check run died in setup withAttributeError: 'ModelCheck' object has no attribute 'res_dir'— no objective value at all, not merely a noisy tail.ModelCheckdeliberately does not subclassAlgorithm, so it has nores_dir, and none ofstop_reason,completed_simulationsortrajectoryeither; the fit-phase recording that reads all three was above the branch too. Both now sit inside it, with the boundary stated in a comment so the next addition tomain()lands on the correct side of it. A check run still writes nomethod_chain.json: it is one evaluation of the parameters as given, not a chain of search phases. The regression test that was missing — ajob_type = checkjob driven end to end throughmain()— now guards the path; every existing check test calledrun_check()directly, which is why two commits landed on top of the break.wall_time_fitno longer silently downgradesrefine = 1to no refine at all (#564, ADR-0107).refine = 1requests a method — search globally, then polish the result with a local optimizer — but a wall-clock-budgeted search runs until the clock stops, so it has no reason to leave anything behind, and the polish (new work, forbidden once the budget is spent, ADR-0093) never started. Not occasionally: 15 of 15 runs in a benchmark campaign (Borghans_BiophysChem1997) configured ascmaes+refine = 1, refine_method = gntractually ran plaincmaes. And the downgrade was invisible — ADR-0093's whole promise is that a budgeted run "writes exactly what a converged one writes", sosorted_params_final.txtandinformation_criteria.txtlooked identical either way and the only trace was one line on stdout. A harness that scores a directory could not tell which method it had measured. A new global keywall_time_refine_frac(default0.1) holds that share ofwall_time_fitback from the search, so the refine runs on a slice the search was never allowed to spend. The run's total is unchanged — one deadline still bounds the whole run, it is just partitioned rather than first-come-first-served — and the split is stated on the console before the search starts. The reserve is a floor, not a cap: a search that converges early hands everything it did not spend to the polish. No reserve is taken when there is no refine to protect (norefine, no budget, or arefine_methodnaming the algorithm the fit itself ran), so a run that asks for no polish is byte-identical to before.wall_time_refine_frac = 0restores the old split, and the resulting skip is now aprint0warning that names the method that did not run, the method that ran alone, and the key that would have made room.- A refined run's
sorted_params_final.txtdescribes the refined point (#564). The refiner wrote its result only tosorted_params_refine_final.txtwhile rewritinginformation_criteria.txtfrom the same end-of-run tail, so two files in oneResults/disagreed about which parameter set they described — and the conventional name carried the point the requested method chain did not end on. A refine's end-of-run output is the run's end-of-run output, and is now written under both names; therefine_-prefixed file is unchanged. - A bootstrap replicate's refine no longer writes into the main run's
Results/(#564)._refine_best_fitredirected a replicate'ssim_dirandfailed_logs_dirto theResults-boot{N}peers but not itsres_dir, so every replicate's polish overwrote the main fit'ssorted_params_refine_final.txtandstop_reason.txt. The refiner now writes where the fit it is polishing wrote. - A refine's wall-time stop reason is appended to
Results/stop_reason.txt, not written over the fit's (#564). Both phases share one Results directory; a run where the search hit the deadline and the polish did has two facts to report, not one that replaces the other.
- Multiple shooting,
job_type = ms(#563, ADR-0110). The consumer of the constrained-transcription layer below, and the thing #563 was actually asking for. Each scored experiment's time course is cut at knots; segment j is integrated from its own start state — segment 0's is the model's own initial conditions, and each interior knot carries an auxiliary state that is searched, bounded and differentiated but is never a reported fit result — and continuityPhi_j(z_j, theta) - z_{j+1} = 0is enforced by an augmented Lagrangian whose subproblem is solved bygntr's own Gauss-Newton trust-region step machine. Every reported score comes from discarding the auxiliary states, re-simulating theta with ordinary single shooting, and scoring that, so a run that leaves continuity unconverged scores as what it actually is — and every certified iterate lands in the ordinary trajectory at that score, sosorted_params, the best-fit simulations, the information criteria and the inference-data sidecar are produced by the same code every otherjob_typeuses. Why it is worth the machinery: onBorghans_BiophysChem1997a correctly-shaped oscillator whose period is wrong by more than about 3 % scores worse than fitting no dynamics at all, so under single shooting the flat line is the ceiling on essentially the whole box and fifteen independent global searches terminate at it. Over one short segment a period error cannot accumulate: the information moves out of a residual term that saturates and into continuity defects, which carry a direction. The prototype's structural finding is what keeps the implementation small — a segment-start state is anICroute with chain-rule factor 1, so the existing gradient/Fisher assembly builds its column with no new residual math, and each segment is presented to it as an ordinary experiment. The continuity block is the only new assembly surface. Knots are named by their exact fraction of the horizon, so a coarser rung recognises a finer one's knots and the4-2-1ladder continues rather than reseeds. New keysms_segments,ms_coarsening,ms_penalty,ms_penalty_growth,ms_max_penalty,ms_feasibility_tol,ms_optimality_tol,ms_inner_iterations,ms_aux_decades,ms_max_iterations, defaulted from ADR-0109's measurements rather than from taste. Requires the bngsim backend — a knot carries the model's state, so both a generated network (.net) and an SBML/Antimony model are supported, through two backends that differ only in what a simulation returns: on the SBML path the columns an experiment scores and the columns a continuity row differences are the same columns, and on the.netpath they are not, so that backend asks for the observable and species selector families together and one integration still serves both (#577). A network-free (NFsim) model enumerates no state and is refused. It also refuses, by name, a fit whose scored quantity is a function of a whole series — an analytic per-series scale, a data normalization, a cumulative-to-incident difference — since cutting the series would change it. An analytically profiled noise scale (ADR-0108) is deliberately fine: it is profiled over pooled residuals, so the segments pool the same ones, and the constraint terms never enter the likelihood. What is not claimed: that multiple shooting improves the typical fit (48 paired starts: 24–24, medians tied at every radius, at 2–7x the simulations), or that it solves Borghans from an uninformed start (0/24). The measured case is the tail and the robustness. Segment simulations run serially on the master in this cut; parallelising them, and the acceptance benchmark, are the follow-on work. - A constrained-transcription layer,
pybnf.transcription(#563, ADR-0109). Infrastructure for restating a fit as a larger, better-conditioned problem with internal auxiliary variables and equality constraints that tie them back together — the reusable half of multiple shooting, which will be its first consumer. Four pieces: an augmented variable layout that carries the fit's reported free parameters and the transcription's internal blocks in one vector while keeping them rigorously apart (an auxiliary state is searched, bounded, and differentiated; it is never a reported fit result); an equality residual/Jacobian interface whose Jacobian is block-sparse with a condensing seam left open, and whose defects are scaled so one penalty means one thing across states of different magnitude; the augmented Lagrangian offered in all three forms PyBNF's optimizers consume (scalar forlbfgs, an exact stacked least-squares residual fortrf, Gauss-Newton forgntr); and an optimizer-agnostic augmented-Lagrangian outer loop with a transcription homotopy and best-iterate certification through the ordinary single-shoot path. No behaviour change to any existing fit: nothing imports it yet, it defines no configuration key and nojob_type, and it makes no simulator call — which is what lets the whole layer be verified offline (93 tests, ~1.4 s) against an equality-constrained quadratic whose multiplier is known analytically and a closed-form linear-ODE shooting problem measured against an independently computed single-shoot optimum. Three measurements from the #563 prototype are baked into the defaults rather than left as tuning advice, each contradicting the plan that preceded it: the penalty schedule starts tight (rho0 = 10,gamma = 5beat0.1/3on quality and halved the cost), the segment ladder is the mechanism rather than a later refinement and starts in the middle (4-2-1, not8-4-2-1— many short segments certified worse than their own start under partial observability), and a run reports its best certified iterate rather than its last (on one start the final stage held-147.0while an earlier iterate certified at-196.3). noise_profiling = 1: profile an estimated noise scale out of the search analytically (#562, ADR-0108). ADR-0066 already profiles a declared column's optimal multiplicative scale out of the fit; this is the other half of the same classical trick. Every noise parameter declared= fit <parameter>is removed from the search and replaced, at each evaluation, by its closed-form maximum-likelihood value over the scored points that share it — the weighted residual RMSsqrt(sum w r**2 / sum w)for the Gaussian families (normal/lognormal/lnnormal), the weighted mean absolute residualsum w |r| / sum wforlaplace. Opt-in;0(the default) is an exact no-op. Why it matters beyond the dimension count: at a random point in the box the sampled scale is nowhere near its optimum, so thelog sigmaterm dominates and a global sampler ranks candidates mostly by how wrong their sigma happens to be rather than by how well their dynamics fit. OnBorghans_BiophysChem1997every optimizer that can run it converges to the same attractor, and that attractor is exactly the no-dynamics solution (a flat line at the best constant with sigma at the residual RMS,-51.204092analytically and-51.204092reported). Across the Grein et al. 2026 subset-I corpus a plain free-parameter sigma accounts for 32 parameters in 13 of 23 slugs — 4 % to 33 % of the search. A profiled scale also has no box to run into, so a fit can no longer optimize its sigma into an upper bound and absorb model misfit as "measurement noise" (Schwen_PONE2015'sIR_obs_std). The switch is all-or-nothing within a fit and is refused before the run starts, naming the reason, for anything without a closed form: aformula/prediction_formula/ per-measurement sigma, astudent_tdf, theneg_bindispersion, alocation = meanprediction on a log scale, one free parameter serving as the scale of two different families, or a fit with nothing to profile. A fixed scale (a data column,fix_at,relative) is not searched, so it is simply left alone. Refused for the Bayesian samplers too: profiling maximizes the nuisance out where a posterior integrates it out, so the draws would not be posterior draws. Profiled parameters stay declared (the same.confruns with and without the key; their bounds and prior become inert) and stay estimated, so they keep counting inkininformation_criteria.txt— otherwise every AIC/BIC would shift between the two runs. Their fitted values are written to the newResults/profiled_noise.txtand echoed on the console, since a value the fit solves for rather than proposes is not a coordinate of the best parameter set and appears in nosorted_params_*.txtrow. Gradient support comes free by the envelope theorem —job_type = lbfgsandgntrconsume the exact scalar gradient with the sigma columns dropped, and no new forward sensitivity is needed.job_type = trfrefuses a profiled fit (as it already refused a searched free scale): under profiling the least-squares residual norm is identically constant, so a trust-region residual model carries no information about the parameters.Results/method_chain.json: which methods a run actually executed (#564, ADR-0107). Written by every run — budget or no budget — it carries the chain the conf requested (requested_methods), the chain that ran (executed_methods), and one entry per phase (the fit, the refine, each bootstrap replicate) with its status (completed/wall_time_expired/skipped), its stop reason, its elapsed seconds, its completed simulations, and the best objective it reached.requested_methodslonger thanexecuted_methodsis the machine-readable form of a downgrade, so a scoring harness can assert on the method it measured in one line instead of parsing stdout. Abootstrapphase recordsreplicates_requested/replicates_completed, becausebootstrap = 30in a conf is worth nothing if the budget stopped the run at 11. The file is rewritten after every phase (so a run whose refine raises still leaves the record of the fit that happened), is strictly valid JSON (a non-finite objective is recorded asnull, neverInfinity), and — likestop_reason.txtandinformation_criteria.txt— a failure to write it is logged and swallowed rather than taking a finished run down.
- An SBML model on
sbml_backend = bngsimno longer charges every species for the tolerance its smallest one needs (#549, ADR-0105, supersedes ADR-0103). ADR-0103 derived a singleatolfrom the median species value because bngsim'sSimulator.runtook only a scalar, and it wrote down what that cost:Brannmark_JBC2010reads3.3e-10, which holds itsIR/IRS/Xspecies at ~10 to3.3e-11relative — three decades tighter than thertolthat governs them — to buy a resolution for a1.76e-9transient that the same ADR had already decided not to chase. Now that lanl/bngsim#196 routes a vector toCVodeSVtolerances, that over-tightening is given back per species:atol_i = clamp(sbml_rtol * y_i, the model's scalar, 1e-8). Measured on 100 points sampled from Brannmark's own fit box with the fit's sensitivity request applied, 39 dead simulations become 33, in 428 s rather than 576 s. The lower clamp is the change, and it is there because the obvious rule loses. "Resolve each species tortolof its own magnitude", full stop — which is what #549 proposes — puts that transient at1.76e-17, and on the same 100 points killed 91 of 100: ADR-0103's withdrawn minimum rule reappearing one species at a time. The1e-16floor #549 asks about rescued nothing (91 either way), because the damage is done well above it. A tolerance belowrtol*|y|is inert until a species has decayed far below its nominal value, and what it then demands is that a species which has decayed into nothing be resolved as if it had not; telling that apart from a genuinely tiny species needs the trajectory, not the initial values. So every entry now lies in[the model's scalar, 1e-8]: no species is integrated more tightly than PyBNF integrates it today, and no model that runs today can start failing. A control confirms the mechanism is the values and not the plumbing — the same scalar sent as a uniform vector reproduces the baseline exactly, 39 and 39. Over the 23-slug subset-I corpus 19 models take the same scalar call as today and the 4 that #546 tightened take vectors, which is the shape of a refund: only a model that was charged can receive one. A species declared at zero has no magnitude of its own and falls out of the same expression at the model's scalar, leaving it where ADR-0103 put it. The derivation stays a property of the model file — read off the SBML document at load, held for the whole fit, never re-derived from the fit point, which is why bngsim's state-readingAUTOtoken is not used: a tolerance that moved with a fitted initial condition would put a step in the objective wherever the derivation crossed a rounding boundary, and it would be invisible, since the objective still looks correct and only the search behaves oddly. ADR-0103's median-derived scalar does not retire either — it becomes the steady-state convergence cutoff, passed explicitly whenever the vector is in force, because bngsim's own fallback for that cutoff is the Simulator's1e-8rather than anything derived from the vector, and taking it would silently return everytime = infmeasurement and every pre-equilibration phase to "equilibrium at t = 0" on a small-scale model.sbml_atolremains a single number and remains the off-switch: stating it integrates every species at that value and pins the pre-#196 code path bit-for-bit. A bngsim without the capability keeps ADR-0103's scalar unchanged, detected by name (bngsim.AUTO) rather than by version, because the build that first carried #196 declares the same version string as the wheel that predates it.
-
The CMA-ES restart battery's TolFun trigger no longer gets more eager as the fit gets better (#550, ADR-0106, amends ADR-0082). ADR-0082 made TolFun's stagnation threshold relative to the current objective,
frange <= cmaes_stop_tol * max(1, |f|). PyBNF minimizes a negative log-likelihood, which is unbounded below, so|f|grows as the fit improves and that threshold rises as CMA-ES approaches the optimum — while Hansen's window10 + ceil(30N/lambda)shrinks as IPOP grows the population (30 generations atlambda = 32, 11 atlambda ≈ 1900). The two move in opposite directions and compound, so a late restart must improve by more within fewer generations than an early one, and IPOP's large-population restarts — the ones grown to do the heavy lifting — were the ones cut off mid-descent. OnElowitz_Nature2000(Grein subset-I, k=21) restart 3 was descendingOG53.0 → 26.4 → 5.105 and was killed at the bottom of that descent because0.001/generation × 11 generations = 0.0105fell just under1e-4 × 121.06 = 0.0121; across two fits all 14 restarts fired on TolFun and not one run ever converged. TolFun now compares an absolute range in objective units, as Hansen'stolfundoes (pycma's relative varianttolfunrelnormalizes by the run's initial median, a scale that does not drift with fit quality either; neither reference form uses the current|f|). On that fit the threshold becomes the configured1e-4and the descent clears it by a factor of 100. TolFun also gains its own key,cmaes_tolfun.cmaes_stop_tolis a step length in the parameter sampling space and TolFun is a range in objective units; no single value is right for both, and reaching a TolFun that fired at all on the fit above meant declaring the search distribution converged at1e-4inu, seven orders looser than the default. Unset,cmaes_tolfunfollowscmaes_stop_tol, so an existing config keeps the threshold magnitude it had — the only change is dropping the|f|factor, which can only make TolFun fire less, and a fit whose objective satisfies|f| <= 1is unchanged outright. The restart reason now also reports the tolerance it used (range 0.0105 over the last 11 generations, tolerance 0.0001), so a restart's arithmetic is checkable from the log.cmaes_restarts = 0(the default) is untouched: the battery is still restart-gated (ADR-0070). -
A PEtab v1 problem whose parameter table merely has a prior column no longer loses its log estimation scale (#548).
petab1to2_preserve_scalere-injects theparameterScalethatpetab.v2.petab1to2drops, skipping any row that already carries a prior so a scale petab1to2 already folded into one is not clobbered. That guard is right in intent and impossible to implement in v2 alone: petab1to2 materializes v2's implicit default —priorDistribution = uniformover the bounds — into the converted table whenever the v1 table has a prior column at all, even an entirely empty one, and after conversion a materialized default and a declareduniformare the same cell. So the decider was whether the upstream TSV happened to carry a prior column, a cosmetic property of the file:Zhao_QuantBiol2020(four prior columns, 100% empty) lost all 28 of its log10 parameters andSchwen_PONE2014(six realparameterScaleNormalpriors, the rest blank) lost 24 of 25, whileGiordano_Nature2020, whose v1 table has no prior column, converted correctly. The conversion now reads which rows carried a prior from v1, where a blank is still a blank, and skips only those;inject_log_uniform_priorsgains an optionaldeclared_prior_idsand keeps the conservative v2-only reading when it is omitted. This was silent by construction: the re-injected prior sets only the search scale and initial sampling, and PyBNF's optimiser objective excludes the prior, so the objective, thesimulatedDataoracle check and the finite-difference gradient check all still passed —Zhao's nominalJ_paperis unchanged to 13 significant digits. Only the search was wrong, and a multi-decade parameter sampled linear-uniform presents as a fit needing more starts:Zhao'sgamma_*sit on[1e-08, 1]with an optimum near 0.05–0.39 and itssd_*on[0.001, 1e5]with MLEs of 186–5013, so across 28 parameters effectively no box-sampled start lands near the basin. A 100 × 1000 multi-start stalled at ~718 and was decelerating; on the corrected scale it beat that in under 90 seconds.Schwenis the discriminating case — its six declared priors survive aslog-normal, its five genuinelylinparameters stayuniform. -
An SBML model whose species are far below 1 no longer integrates — and differentiates — at a tolerance larger than its own state (#546, ADR-0103).
Giordano_Nature2020's assembled gradient disagreed with central differences on 41 of its 50 fitted parameters, by up to 26%, identically at every finite-difference step size, with no refusal and no warning. The model is piecewise-in-time — 110piecewiseexpressions across 14 assignment rules, all gated on the COVID NPI stage boundaries — and the error partitioned along whether a parameter sat behind a time gate, so it read as unhandled switching. It is not: bngsim's SBML loader already registers everytimeinequality as a CVODE root (13 for this model), and the crossings are landed on exactly. The defect is the absolute tolerance. CVODE weights each state byrtol*|y| + atol, so a constantatoldeclares values beneath it to be noise — a statement about the model's units, and bngsim's1e-8is BNG2.pl's, right for a model in molecule counts. Giordano is a population-fraction model whose species sit at1.7e-8..1, median3.7e-7: its early trajectory carries no significant digits, and the forward-sensitivity solve carries fewer still, since CVODES scales the state tolerances by the parameter magnitude for the sensitivity vectors. The gate correlation is real but incidental — a gated parameter acts only inside its own stage window, and the earliest windows are where the states are smallest. Tighteningrtolby four decades changes nothing; tighteningatolfixes it. The bngsim SBML/Antimony path now derivesatolasrtoltimes the model's median strictly-positive species initial, clamped to at most the backend default and at least1e-16, so it can only ever tighten: across the 23-model subset-I corpus 19 are untouched and 4 tighten. Giordano's worst column goes 7.7e-02 → 4.5e-04 for ~14% more wall clock; Brannmark 5.0e-05 → 3.6e-05 and Bertozzi 2.7e-05 → 2.4e-05 at no measurable cost. The median rather than the minimum, becauseBrannmark_JBC2010seeds one transient intermediate at1.8e-9against principal species at0.1..10, and resolving that asks for1e-17, which makes the model fail outright onmxstepat interior fit points. Unchanged: every BNGL/net model (its tolerances come from the actions block, and BNG2.pl parity is what that backend is measured against), every stochastic run, the RoadRunner backend, and every SBML model of order-one scale. -
A scalar fit no longer re-derives the analytical Jacobian on every action (#544). #543 warmed the cached engine template so clones inherit the compiled sensitivity RHS, but it warmed only when a sensitivity request was active — and the same never-warmed-parent shape costs the scalar path too, one artifact over. bngsim's
Simulator.__init__callsmodel.prepare_analytical_jacobian(); PyBNF builds thatSimulatoron the per-action clone, and the clone is discarded.clone()carries the_jac_attemptedsentinel parent → child precisely so a derived parent yields cheap clones, but nothing ever derived it on the parent, so every scalar action re-ran the SymPy derivation from scratch. PyBNF now warms unconditionally and lets the shape of the warm depend on the request rather than gating the warm itself on there being one. Measured through PyBNF's own action path on the 44-speciesyeast_cell_cyclemodel: 0.1542 s → 0.0057 s per action (27x), derivations 10 of 10 → 0 of 10. As reported on #544,Smith_BMCSystBiol2013goes 0.0401 s → 0.0224 s, 20 of 20 → 0 of 20, taking that job's shipped 64,000-evaluationcmaesbudget from ~36 core-hours to ~14. Trajectories are bit-for-bit unchanged. Two guards this needed: a scalar warm must not satisfy a later gradient warm (bngsim clears a plain-RHS artifact and regenerates it at the first sensitivity request, so a scalar-warmed template would be correct and save the gradient path nothing) — the warm-state predicate and the per-shape attempt memo both answer "not yet" for the sensitivity shape; and a model with no ODE action warms nothing, since bngsim derives the Jacobian under ODE dispatch and nowhere else, having deliberately moved it off the load path so a stochastic run never pays SymPy. Applies to every SBML/Antimony fit throughsbml_backend = bngsim, on everyjob_type; the larger the model the bigger the effect, since the derivation scales with the network and the solve does not. The.netbackend clones from a held_engine_modelin the same never-warmed shape and does re-attempt the derivation per evaluation (measured 4 of 4), but it costs it essentially nothing: a BNGL network is all-Elementary, so bngsim takes its closed-form C++ Jacobian rather than SymPy — 0.1511 s → 0.1472 s per evaluation onegfr_ground.net(356 species), within noise. Left alone rather than warmed on a measurement that does not justify it. -
A gradient fit no longer rebuilds the analytical sensitivity RHS on every action (#543).
_get_engine_templatecaches one loaded bngsim model per SBML text per worker process and #415 clones it per action, precisely so the parse and the derived Jacobian are paid once. bngsim'sclone()cooperates, carrying the compiled sensitivity artifact parent → child — but theSimulatorwas built on the clone, so the clone was what discovered and recorded that artifact, and the clone is discarded at the end of the action. Discovery flowed child-ward only: the template's_codegen_so_pathstayed empty forever, and every action regenerated the C source, and every symbolic derivative behind it, because bngsim keys its compiled.soon a hash of that source. PyBNF now warms the template once per process, with the sensitivity request the actions will use (a scalar-shaped warm would be correct and save nothing — bngsim regenerates it at the first sensitivity request), soclone()propagates it from then on. Measured onSmith_BMCSystBiol2013(133 species, 16 sensitivity columns) through PyBNF's own action path: 2.015 s → 0.537 s per action, source generated 4 of 4 times before and 0 of 4 after; the tensor is bit-for-bit unchanged. Inside a realgntrrun of that job — dask worker, condition applied, the experiment's own sample times — its first action goes from 3.731 s to 0.327 s. Invisible in a profile that looks at simulation — the integration is untouched and all of the difference isSimulator(...)construction. A scalar (metaheuristic) fit never generates the source at all and was left untouched here (0.194 s per action either way), which bounded who this entry helps; #544 above warms it for a different artifact. The.netbackend clones from a held_engine_modelin the same never-warmed shape but is not affected here: its.netcodegen memo is keyed on the file path rather than on generated source, and it regenerates nothing (measured 0 of 6). -
A pre-equilibration condition that doses a species from a fitted parameter no longer reports a zero gradient column for it (#538, ADR-0101).
preequilibrate:applies its condition inline, so a species target becomes asetConcentrationwritten before the first phase — andModel.set_concentrationreads an assigned amount as a literal initial condition (∂x_k(0)/∂θ = 0), retiring whatever seeding the species'.netexpression carried (lanl/bngsim#113). ADR-0098 supplies that row for a write between two phases; with nothing pending it had nothing to rebuild and left the write to the backend, so an amount like"A()" = 2*k_degcontributed exactly zero tok_deg's derivative. Nothing failed and no refusal fired: the fit simply walked a wrong steepest direction to a plausible answer. PyBNF now declares the assignment's own∂x_k(0)/∂θ(Model.declare_ic_sensitivity, the API bngsim documents for a hand-assigned θ-dependent initial condition), so bngsim's own seeding starts from it — narrowly, only when a fitted parameter reaches the amount, so every protocol whose gradient was already right reaches the backend through the same calls as before. AnaddConcentrationre-declares the row its constant shift left alone. Visible only with a fixed-duration equilibration (equil_t_end:, what the preincubate → wash → dose-scan protocols use); a steady-state equilibration relaxes the dose away, so the derivative is genuinely zero there. Also new: an intervention amount that reads a fitted parameter no requested forward-sensitivity column carries is now refused by name, on both this path and the mid-protocol one, rather than silently contributing a zero row. -
A pre-equilibrated dose-response experiment can now be fit by a gradient method (#532, ADR-0098). The preincubate → wash → dose-scan protocol (
preequilibrate:+condition:+type: parameter_scan) refused every scored gradient evaluation, and the refusal landed at scoring — so atrffit of Erickson 2019'sigf1rjob "finished" withinfat all ten starts and said onlyUnknown error during job bestfit_infocrit. Two things were wrong. The guard itself was stale: bngsim 0.12.0 (lanl/bngsim#81, #111) carries the state each dose restores together with itsdx/dθ, which is exactly the capability the guard said did not exist; it is now a capability gate (bngsim >= 0.12.0, the newpyprojectfloor), and each dose's tensor stacks down the dose axis like any other scan's. Underneath it, the protocol's wash was silently discarding the equilibration's derivative —Model.set_concentrationdrops the pendingdx/dθrather than guess an externally supplied amount's, so no pre-equilibrated experiment with a species intervention could be gradient-fit, a measured time course failing outright withcarry_sensitivities=True, but no matching forward-sensitivity seed from a prior phase is available. PyBNF now supplies the row it knows: the intervention's own∂x_k(0)/∂θ—0for a literal amount, the exact derivative for one written over model parameters (differentiated through the.net's derived ids), the carried row for anaddConcentration— with the rest of the matrix preserved, and an honest refusal naming the assignment when it lies outside the arithmetic grammar. AresetConcentrations()that follows asaveConcentrations()is likewise recognised as returning to a carried state, which is what made a model's second pre-equilibration experiment refuse. All sevenigf1rrate constants now agree with central differences to ≤ 2.3e-04 on all three experiments, and the fit reaches a finite objective. -
A refusal raised while simulating now stops the fit and states its reason, instead of returning
infat every start (#532).Job.run_simulationswallowed a user-targetedPybnfErrorinto its generic "unknown error" arm, so a property of the setup — a model construct thisjob_typecannot handle, a missing backend capability — was reported once per evaluation as a failed simulation and the run continued to a meaningless finish. The documented fail-fast policy (re-raise; it would fail every job) existed one layer up and was never reached. Scoring failures are unchanged: a per-point objective failure still penalizes that point (#388). -
A gradient start that reaches a point it cannot differentiate no longer takes the whole multi-start fit down with it (#528, ADR-0092). A stiff parameter point can score finitely while its forward sensitivities diverge, leaving a finite objective with a non-finite gradient. That model went straight into the trust-region factorization, where LAPACK refuses it (
Sorry, an unknown error occurred: numpy.linalg.LinAlgError: SVD did not converge) and the exception unwound out of the run loop — 19 healthy starts of a 20-startgntrfit discarded because of one, which inverts the reason multi-start exists. (lbfgsaborted the same fit by a different route: its NaN direction proposed a NaN point, rejected asOutOfBoundsException: Free parameter k cannot be assigned the value nan.) An unusable local model is now treated exactly as a failed simulation already was: mid-search the trial is rejected — the trust region shrinks, or the line search backtracks — and that start carries on from its current iterate; at the start point that one start stops, saying which model was unusable (the Fisher model (gradient + EFIM Hessian) at the start point is not finite (the point scored, but its derivatives did not)), while every other start keeps running and the global best is taken across the survivors. The two LAPACK calls in the step math (svd,eigh) are wrapped as well, so a factorization that fails on finite-but-pathological input routes the same way.profile_likelihood, which drives the same runners, was a third casualty of the same missing guard: a slice whose derivatives diverge now ends that one direction at a wall it names, with the un-optimizable grid point contributing no profile value — rather than entering an un-minimized upper bound as if it were the profile, which would inflate that point's Δχ² and could close the confidence interval too narrowly. A fit whose models are all finite is unchanged. -
A negative count is no longer scored as a perfect fit, nor counted in
n(#523, ADR-0090). Theneg_binfamily has a negative observation contribute nothing to the objective — right for the fit, since a negative count has no negative-binomial probability, and real surveillance data contains them (a downward revision of a cumulative total makes a negative daily increment). But a negative-binomial PMF is self-normalizing, so that zero cost becamelog p = 0— probability one — in the pointwise log-density, a better per-point density than the family assigns any real count, including one the model predicts exactly. Those points were also counted as scored points, enteringnfor AIC/BIC and the LOO/WAIC observation axis. An observation outside its noise family's observation domain is now excluded exactly as a NaN observation already was: off the observation axis, out ofn, and reported once per observable with a count (excluded 4 measurement(s) of 'cases' in ...: this observable's noise model scores only a non-negative count). Scoring data containing negative counts now matches scoring the same data with those rows deleted. The cost path is deliberately unchanged — such a point still contributes nothing to the objective and to the gradient — and every family whose support is the whole real line (normal,lognormal,lnnormal,laplace,student_t) is byte-identical. -
Steady-state (
time = inf) measurements now load and fit (#521, ADR-0086). A PEtab problem measured only at equilibrium imported fine but crashed at configuration load (OverflowError: cannot convert float infinity to integer): the experiment was materialized as an ordinary time course, which derives its step count from a (here infinite) endpoint. PyBNF's only steady-state route was the dose-responseparameter_scanof ADR-0046, which needs a swept axis a plain equilibrium observation does not have. An.expwhosetimecolumn is allinfis now recognized as a steady-state experiment: it emitssimulate({...,steady_state=>1,n_steps=>1})— the relaxation-with-early-stop primitive pre-equilibration already used — and the objective scores the datum against the run's final (equilibrium) row.t_end:bounds the relaxation (default1e6) instead of timing a readout, andtype: steady_statemay state explicitly what the data implies. Supported on BNGL (BNG2.pl/bngsim), bngsim SBML/Antimony, and RoadRunner (which uses its own steady-state solver, falling back to the bounded integration); forward sensitivities are carried at the equilibrium, sotrf/lbfgs/gntrfit these problems. NFsim (method: nf) has no steady-state solve and is refused, as is an experiment mixinginfwith finite times. This unblocksBlasi_CellSystems2016, the last unimported subset-I problem of the Grein et al. 2026 benchmark collection. -
PEtab conditions measured only at
t = 0now load and evaluate as initial-state observations (#510). A data-derivedTimeCoursepreviously required at least one positive output time, so one legitimate initial-state condition rejected the entire imported problem (including every ordinary time course); this blockedSchwen_PONE2014. SBML/RoadRunner and SBML/bngsim now return the initialized model as a one-rowt = 0trajectory without invoking an integrator. The bngsim gradient path also supplies the initial-condition identity derivative and differentiates parameter-driven SBMLinitialAssignmentexpressions, sotrf/lbfgs/gntrretain correct forward sensitivities for an initial-only experiment. -
PEtab natural-log Gaussian observables now import exactly (#509, ADR-0084). PEtab v1
observableTransformation = logand v2noiseDistribution = log-normalpreviously reached PyBNF's internalGaussian(LN)kernel but could not be serialized into the generated.conf;import_jobraisedNotImplementedError. The new explicitlnnormalnoise family isGaussian(additive_on=LN, location=MEDIAN)and is kept distinct from PyBNF's existinglognormal(log10) family. Imports now preserve the natural-log residual and sigma units, and normalized pointwise log-likelihoods use the natural-log Jacobian-log(y)(soinformation_criteria.txtis on the correct absolute scale). This unblocksBlasi_CellSystems2016andLaske_PLOSComputBiol2019. The exact reverse mapping also exportslnnormalas PEtab v2log-normal; log-scale Laplace remains unsupported by the native configuration surface. -
PEtab import now preserves replicate-specific
observableParameters/noiseParametersbindings (#508, ADR-0083). The per-measurement sidecar was keyed only by column, time, and placeholder, so repeated PEtab cells from different replicates collided and the last replicate's token silently replaced the others. This blockedFiedler_BMCSystBiol2016by orphaning the first gel's scale parameters and could silently fit other problems with the wrong per-row scaling/noise binding. Replicate-aware sidecars now add a 1-basedreplicatecolumn, using the same row-dealing partition that creates each_repN.exp; configuration loading and PEtab re-export select tokens by(replicate, time). Legacy four-column sidecars remain valid and retain their shared-across-replicates meaning. -
PEtab import:
observableParameters/noiseParametersplaceholders with a fixed noise parameter, multiple noise tokens, or an affine/prediction-scaling noiseFormula now import (#495, ADR-0075). Three related gaps in the placeholder→parameter mapping left benchmark-collection problems unimportable. (a)Oliveira_NatCommun2021— anoiseParametersid (sd_cumulative_*) that is fixed (estimate=0) was emitted as afitfree sigma the.confnever declared, so the job failed to load; it now inlines as a constant sigma. (b)Fiedler_BMCSystBiol2016— a multi-tokennoiseParameterscell (s_gel;sigma, anoiseParameter1 * noiseParameter2formula) was never split (onlyobservableParameterswas), so the whole cell was mis-read as one id; it now splits and binds eachnoiseParameter${n}per data point when row-varying. (c)Raia_CancerResearch2011— an affinenoiseParameter1 + noiseParameter2 * (species…)produced anoise_modelline that referenced the simulated trajectory aformulasigma cannot see, failing to parse; it now imports as the newprediction_formulasource (see Added). All three land on crafted simulator-free fixtures scored against a hand-derived NLL. -
PEtab SBML import: an
observableFormulareferencing an SBMLassignmentRulevariable now imports instead of being rejected as "not a model entity" (#493). AnassignmentRule-defined variable (a<parameter>/<species>withconstant="false"whose value is set by an<assignmentRule>) is a derived model output — the backend recomputes it at every step — so it is exactly the kind of quantity an observable is built from (the SBML analogue of a BNGL global function, which PyBNF already accepts).import_job's measurement-model importer recognized only species / parameters / observables / functions, so six PEtab benchmark-collection problems (Giordano_Nature2020,Laske_PLOSComputBiol2019,Rahman_MBS2016,SalazarCavazos_MBoC2020,Smith_BMCSystBiol2013,Zhao_QuantBiol2020) could not be imported at all — a bare-name formula raised "has a bare observableFormula … which is not a model entity" and an expression formula raised "references … which is not a known model entity". The importer now inlines any referenced assignment-rule variable down to the species/parameters its rule is defined over (recursively), exactly the resolution the config-load measurement layer already performs (#465, ADR-0036); the model file is carried byte-verbatim and a formula naming no rule variable is returned unchanged (the bare-name common case stays dependency-free). -
PEtab import:
observableTransformation = log10is no longer dropped in the v1→v2 conversion (#499). A PEtab v1 observable withobservableTransformation = log10(Perelson_Science1996, Borghans_BiophysChem1997, Elowitz_Nature2000, and other multi-decade-signal benchmark problems) imported as a lineargaussiannoise model, so the fit optimized the wrong objective — a linear residual with no change-of-variables Jacobian instead of thelog10residual the problem (and the paper) specify. Thelog10transformation was silently dropped bypetab.v2.petab1to2(PEtab v2 removed theobservableTransformationcolumn and has nolog10noiseDistribution; it downgradeslog10-normalto a blank distribution), andimport_jobread onlynoiseDistribution, so the observable resolved toGaussian(LINEAR). Directly parallel to theparameterScaledroppetab1to2_preserve_scale(#491) already fixes:pybnf.petab.petab1to2_preserve_scalenow also re-injectsobservableTransformationas a preserved extra column on the converted v2 observables table (v2 lint-clean; other tools ignore it). Since v2 has no faithfullog10noiseDistribution, this extra column is the only channel for alog10residual — the observable twin of thelog-uniformparameter-scale re-injection.- The importer selects the noise family's additive scale from
observableTransformation, not just the family fromnoiseDistribution.log10 + normal→ the nativelognormalfamily (Gaussian(LOG10, MEDIAN), which already carries the correct log10-space residual and theΣ log(y·ln10)Jacobian), emitted asobjective = lognormal(or anoise_model = lognormal, …line);log + normalmaps to the natural-logGaussian(LN)(v2'slog-normal). Thepybnf.petab.observablesadapter reads it the same way (log10→ LOG10,log→ LN,lin→ unchanged), with a guard against a transformation that contradicts a lognoiseDistribution. Natural-log Gaussian now routes tolnnormal(#509, ADR-0084); loglaplacefamilies still raiseNotImplementedError— the boundary stays in code, never a silent mis-recovery. A linear problem is byte-for-byte unchanged.
- The router now reads what the backend seeded instead of inferring it, so an IC-seeding
parameter is routed exactly once (#537, ADR-0100). bngsim 0.12.2 (lanl/bngsim#157, answering
our lanl/bngsim#155) exposes
Model.effective_ic_sensitivity(), the{species: {param: ∂x(0)/∂θ}}the solver will actually be seeded with, from model structure alone and with a present-but-zero entry distinguished from an absent one. The rule is now stated rather than guarded around: route a bound id's own parameter axis, and add an initial-condition term only for a(species, param)pair the backend reports absent. That subsumes both of the defects either side of it — #535 was an axis dropped that was needed, #537 an axis kept that duplicated, and both came from inferring what the parameter axis contained.ode_rhs_symbolsis demoted to an optimization (dropping a provably identically-zero axis), so a model that cannot answer keeps its axis instead of facing two silent wrongs; the refusal added for that case is gone, as is thelowered_ic_speciesbuild discriminator that existed only to survive the interval.Fiedler_BMCSystBiol2016returns to 3.68e-06 on 0.12.2 — its value before lanl/bngsim#147 widened the seeded class — and seven slugs whose parameters seed an initial condition switch from the ic axis to the parameter axis, unchanged to the digit. The minimum bngsim is now 0.12.2. One limit is deliberate: the two axes are only interchangeable in a common unit convention, and the ic axis is rescaled by each species' PyBNF-value-to- concentration factor while the parameter axis is not, so a species whose factor is not 1 keeps the ic route (substituting overstates its column by1/factor, measured across three compartment sizes). Exactly one benchmark model has non-unit factors and it seeds nothing. - A gradient fit is refused, rather than silently doubled, on a bngsim build that seeds a
lowered
initialAssignmentinto the parameter axis (#537, ADR-0100). The backend authors confirmed (lanl/bngsim#155) thatoutput_sensitivities(axis='parameter')is the total derivative —d_param[θ] = (RHS path) + Σ_j (∂x_j(0)/∂θ)·d_ic[x_j]— so a route holding both a parameter's own axis and an IC term is correct only while the backend seeds nothing for that species. lanl/bngsim#147 changes that for compound parameter-only assignments, which it lowers to a synthetic_ic_<species>derived parameter.route_for_modelnow detects exactly that build-and-model combination and refuses by name, soFiedler_BMCSystBiol2016— the one slug in 23 whose free parameters legitimately route both axes, correct on every build through 0.12.1 at ≤3.7e-06 — fails loudly on the first build carrying #147 instead of reporting seven columns at the wrong value. The assembly's numeric guard was also generalized: it now compares the parameter slice against the weighted sum of the IC terms rather than a single slice, which catches a non-unit seed (X(0) = a*X0givesd_param[X0] = 3.0·d_ic[X], agreeing to roundoff rather than bit-for-bit — the counterexample the first cut missed). The net backend is pinned to the same contract by test, having been verified bit-identical one2e_ode_decay.net. - A parameter's own sensitivity axis is not "identically zero" when it seeds an initial
condition — it is the whole derivative, and adding the IC axis to it doubles the column
(#537, ADR-0100). ADR-0097 drops the
sensitivity_paramsaxis of a parameter that only seeds species initial values, documented as sparing a wasted vector on an axis that "would be identically zero". Measured onRaia_CancerResearch2011, that axis is not zero: bngsim seeds∂x(0)/∂pinto it as well (lanl/bngsim#43, widened to compoundinitialAssignmentexpressions by lanl/bngsim#147), sod_param[init_Rec_i]andd_ic[Rec_i]come back bit-for-bit identical across every output. The drop is therefore load-bearing for correctness, and forcing both axes into the route reproduces #537's signature exactly —init_Rec_iat 2.00000× its central difference, every other column untouched. Three changes. The claim is corrected wherever it appears. The unanswerable-model fallback is now a refusal: ADR-0097 kept the axis whenode_rhs_symbols()could not say, on the strength of that false premise, which means one error deletes half a derivative (#535) and the other doubles it — with no safe default left, the router names the parameter and points at a gradient-freejob_type. Both shipped backends always answer, so no fit changes. And the assembly now checks numerically, per experiment: a route holding both its own parameter axis and an IC axis whose tensor slices are bit-identical is refused, since two independent derivatives of a live model do not coincide to the last bit.Fiedler_BMCSystBiol2016, which legitimately routes both axes for seven parameters (their columns genuinely differ — RHS path versus seeding), is unchanged at ≤3.7e-06.
-
Tutorial Lesson 6 no longer teaches a refusal that stopped being one (#536). Its whole premise was that a hard
if(t < tau, …)step in a rate law is not differentiable, sotrfrefuses it and the fix is to smooth the step into a sigmoid. bngsim 0.12.2 differentiates it, and the lesson's three claims all failed when measured: the fit is not refused; its gradient is correct (agrees with a central difference to 3e-06 at a well-conditioned step — the apparent 3e-03 disagreement ath = 1e-6grows ashshrinks, which is roundoff, not a defect); andtau— which the lesson said "the hard-if()model could never expose to a gradient" — is recovered to 1.2e-08, because the solver contributes the crossing term where the switch fires.step_input_trf_refused.confis renamedstep_input_trf.conf, now fitstaualongside the rest, and is checked as a recovery rather than a refusal.The refusal half of the lesson is kept rather than deleted, because Lesson 3 sends readers here for it and because "what does a gradient fit refuse" is still worth teaching — it moves to a new
step_input_ssa_refused.conf, a scoredmethod: ssaexperiment. That reason is durable in a way the old one was not: an SSA trajectory is a random walk, so there is no derivative with respect to the rate parameters to carry, and forward sensitivities exist only for the ODE backend. The smooth-sigmoid variant stays, re-pointed from "the differentiable one" to a conditioning choice — both fit the same parameters to the same accuracy and differ in what they cost the integrator. Without this the nightlyrecoveryjob would have gone red on its own the moment bngsim 0.12.2 reached PyPI, since CI installs bngsim unpinned.
-
sbml_rtolandsbml_atolconfig keys (#546, ADR-0103). State the CVODE tolerances for every deterministic run of every SBML/Antimony model in a fit, on thesbml_backend = bngsimpath — which previously had no way to ask for either, sinceatol/rtolare read only out of a BNGL actions block and an SBML model has none. Unset (the default) leavesrtolat the backend default and derivesatolfrom the model's own species magnitude, as described under Fixed above. Setting either under anothersbml_backendis a config error rather than a silent no-op, and a model whose derived tolerance hits the1e-16floor is told once, by name, thatsbml_atolis where to say so. -
A chain of two or more data-level normalizations on one column is now differentiable (#539, ADR-0102).
normalizationis an ordered chain (ADR-0066), and five of its transforms —peak,init,zero,unit,floor— rewrite the column in place. Stacking two of them (normalization pStat = floor 0.03, peak) was refused on every gradientjob_type, because the sidecar recording how a column was normalized kept one record per column: the second transform overwrote the first one's facts, and its intermediate values were gone with them. The sidecar is now the list of a column's transforms in chain order, and the gradient folds it — each stage's chain rule is the same closed form it always was, read in that stage's own inputs (the previous stage's per-row sensitivities) rather than in the raw ones, so the fold wraps the sensitivity accessor once per stage. The values a stage produced, which its own rule reads, ride along on its record when the next transform overwrites them; a column normalized once — every fit in the wild — retains nothing and costs what it did before, and its gradient is the same arithmetic in the same order. Every normalized value is unchanged: this is about what is recorded alongside them, not what is computed.floor 0.03, scaleis unaffected either way, and a chain of any length still composes with the analyticscale(ADR-0099), the cumulative and per-measurement transforms, and the EFIM path. -
A gradient routing that would read one sensitivity column twice is now refused, not assembled (#537). A route's derivative is the sum over its contributions, so two of them naming the same native
(axis, key)column add that column twice — and the result is a clean integer multiple of the true derivative, which nothing downstream can detect: the objective stays finite, smooth and plausible, and the fit simply walks a scaled surface to a wrong answer. That is the shape aRaia_CancerResearch2011column came back in, once, during the #535 finite-difference sweep — exactly 2× its central difference oninit_Rec_i, the fit's only initial-condition-axis parameter — and it has not reproduced in six runs at the same point, so there is no confirmed defect to fix. What there is now is a standing check on the narrow invariant it violated. Two halves:route_experimentfolds terms that meet on one column into a single contribution carrying their summed derivative tree (the same sum, one tensor read, andat_pointstill refreshes a point-dependent path), which makes one-contribution-per-column structural rather than incidental; and the gradient, EFIM and constraint assemblers eachcheck_column_multiplicity()on every routing they consume, once per experiment, raising aPybnfErrorthat names the free parameter, the axis and key of the repeated column, and each duplicate's factor. The fold would otherwise blind that check — two same-column terms become one term of doubled factor, indistinguishable after the fact from a legitimate single term — so each contribution records the chain-rule path(s) it came from (origins:bind, orref:<target>per condition parameter-reference) and the check reads those. One path reaching one column twice is the defect; two paths meeting on it is arithmetic, and only the labels separate them once the factors are summed. Provenance is metadata: excluded from equality, hash and repr, so a routing still compares by what it computes. Note the scope: this covers the routing and assembly half of #537's hypothesis. A doubled column arriving from the backend's own sensitivity tensor would still pass, and remains open on the issue. -
A floored or analytically scaled observable is now a gradient target (#533, ADR-0099). The two ADR-0066 normalization primitives shipped with deliberately deferred gradients, so a fit whose experiment declared either —
normalization <obs> = floor 0.03, scale, the chain arbitrary-unit fluorescence / blot data is fit with — was unavailable to every gradientjob_type, refusing with "Analytic per-series scaling ('scale', #479) on column '…' is not differentiable on the gradient path". Both are now threaded. The floor (x' = x + ρ·max x) is additive, so every row picks up the sameρ·s_argmaxterm. The analytic scale is the one transform that is not per-point — itsc*is profiled out of the whole matched series — so the scored valuec*(θ)·ŷ_i(θ)differentiates by the product rule, with∂c*/∂θthe closed-form derivative of the profiling condition itself (the geometric-mean ratio for a log family, the least-squares optimum for a linear one), computed once per experiment and shared by every point of the column. That term does not drop out by the envelope theorem: the profiling is σ-unweighted, soc*is not in general the objective's own minimizer over the scale. A scaled fixed-σ Gaussian fit stays an exact least-squares model, sotrf,lbfgs, andgntrall consume it; the profiled scale is resolved per experiment, so a column scaled in one experiment stays an ordinary column in another. One boundary was stated here rather than silently mis-differentiated — a chain of two or more data-level transforms on one column (floor 0.03, peak), which kept only the last one's facts — and is closed by #539 above. -
A total wall-clock budget for a fit,
wall_time_fit, that finalizes on expiry (#529, ADR-0093). PyBNF's time limits were all per unit of work —wall_time_simbounds one simulation,wall_time_genone network generation — and nothing bounded a run: the only native budget wasmax_iterations×population_size, which is not convertible to wall time without knowing per-iteration cost in advance. The new global key sets the seconds a whole fit may run (wall_time_fit = 10800;0, the default, is unbounded). On expiry the run stops launching work, abandons what is in flight, and runs the normal end-of-fit path against the best point found so far —sorted_params_final.txt, the best-fit simulations,information_criteria.txt, the ArviZ sidecar, the backup rename — so a budgeted result is scoreable exactly like a converged one. Only the stop reason differs, and it is logged, printed, and written toResults/stop_reason.txt(whose presence is the signal; no existing file's format changes). The clock starts when PyBNF starts, so configuration loading and network generation count against it, and one budget bounds the whole run: norefineand no further bootstrap replicate begins once it is spent. This makes PyBNF runnable under wall-time-budgeted optimizer benchmarks (Grein et al. 2026), where the previous alternative — killing the process — lost the artifacts scoring needs. Two overruns are deliberate and documented: one in-flight simulation may run up towall_time_simpast the deadline before it is abandoned, and finalizing re-simulates the best fit once. Refused (rather than silently ignored) forjob_type = hmc, which runs its own in-process sampling loop. -
A model with discrete events fits on the gradient path (#536). An SBML
event— and so an Antimonyat (…): …, the usual way a dosing or stimulation schedule is written — used to refusetrf/lbfgs/gntrat construction. That refusal (#461) was right when it was written: a forward sensitivity carried across a state jump is correct only if the solver applies the event's own jumps⁺ = ∂h/∂x·(s⁻ + f⁻·∂t*/∂p) + ∂h/∂p − f⁺·∂t*/∂pat each fire, and bngsim did not, so it refused sensitivities on any event-bearing model and PyBNF hoisted that refusal to a clean pre-flight gate. bngsim applies the jump now, across a fixed trigger time, a trigger whose threshold is a fitted constant (lanl/bngsim#49), and a state-dependent trigger whose crossing it differentiates in flight (lanl/bngsim#144). The gate is therefore a capability check rather than a blanket structural refusal: an event-bearing model is allowed through, and the subclasses the build genuinely cannot cross (an execution delay; a trigger that is not a single relational comparison) keep a per-simulation refusal naming the reason.The floor is set by silent wrongness, not by a missing feature. A build that refuses is safe; a build that answers an event it cannot actually differentiate, without saying so, is the thing this gate exists to prevent. Three such answers had to go first, which puts the floor newer than bngsim 0.12.1: a trigger reading the state came back as a finite tensor with the event's contribution missing rather than being refused (lanl/bngsim#52, through 0.11.x); an assignment reading the state —
A := A + dose, the repeat-dosing idiom — dropped the carried∂h/∂x·s⁻and restarted the assigned row from zero, measured on 0.12.1 at-10.96against the model's own central difference of-311.20while the identical model built throughModelBuilder.add_eventwas right to2e-6(fixed after 0.12.1 by lanl/bngsim#144's jump-handler rework); and a solver root that fires nothing rewound the state but not the sensitivity history (lanl/bngsim#146, also after 0.12.1). On 0.12.1 or older the refusal stays, and stays blanket, with the message naming the upgrade. The floor lives inpybnf._bngsim_caps(BNGSIM_HAS_EVENT_SENS) and is not a dependency bump: the install floor staysbngsim>=0.11.35, and every scalar (metaheuristic) fit is unaffected either way.The SBML backend also gained a narrowed form of the net backend's #525 wrapper, which the lifted gate makes reachable: bngsim declining to differentiate a model's events is a structural verdict, identical at every parameter set, so it now surfaces as an actionable
PybnfErrorinstead of aFailedSimulationErrorthe optimizer scoresinfand steps around — which would have reported an unsupported event as a failed search. Every other backend failure keeps that back-off, which is the right answer for a candidate point the integrator cannot get through (#492).New coverage is a finite-difference oracle on a two-species event fixture at both levels, the backend tensor and the assembled objective gradient (
tests/test_gradient_events.py): every sensitivity column is scored against a central difference of PyBNF's own trajectory / own loss, including the columns that cross the jump, which is the only instrument that catches a jump term that is missing rather than merely inaccurate. The backend-level oracles run on every build, since what bngsim computes is worth asserting whether or not PyBNF admits the model; the fits, and the bolus-assignment case that set the floor, are gated onBNGSIM_HAS_EVENT_SENS. -
Published-source organization and two curated real-world jobs. The real-world gallery now uses
Author-Year/job_slugpaths aligned with the BNGL-Models job corpus. The former flat Kozer EGFR, Monine TLBR, Gupta FcεRI, and Mitra receptor jobs retain their tested edition-2 configurations under source-oriented collections; curated provenance, validation notes, and reproduction assets accompany the Kozer and Monine jobs. The reduced F5B-only IGF1R teaching fit is replaced here byErickson-2019/igf1r, the authors' published seven-rate, three-dataset preincubate→wash→dose-scan fit (the reduced job remains underexamples/igf1r/). Two additional workstation examples broaden the executable corpus:Salazar-Cavazos-2019/egfr_simpulladds an authors' multisite-EGFR ODE fit, andKirsch-2020/phosphoswitch_bpsladds a four-model, constraint-only BPSL fit. The default corpus test now distinguishes quantitative.expjobs from qualitative.propjobs. -
Workstation-scale exact-SSA real-world examples (#472). The new
examples/real-world/Rijal-2025/collection fits lacUV5/lacUD5 and 5DL1 promoter-noise data from Jones et al. (2014) with the two-state model studied by Rijal and Mehta (2025). Each edition-2 SSA job usesmethod: ssa, 200-trajectory smoothing, and measurement formulas for ensemble mean and standard deviation; paired exact moment-ODE jobs provide deterministic references, with source tables, regeneration scripts, validation notes, and reproduction figures preserved alongside them. All four configurations receive backend-free corpus checks, and the bounded SSA fits enter the opt-in bngsim recovery tier, closing the gap left by the cluster-scale FcERI SSA reference. -
CMA-ES gains an optional bounded per-run generation budget (
cmaes_run_maxgen; #507, ADR-0085). The globalmax_iterationsbudget previously left the initial run and every IPOP / BIPOP large run unbounded, so one run making slow progress in an ill-conditioned local basin could consume nearly the entire fit before later restarts launched. Setting the new positive-integer cap applies it to every run and turns reaching it into the existing per-run restart trigger; the final run then stops at the same cap. BIPOP small runs use the smaller of this user cap and their existing automatic evaluation-balancing cap. The default is unset, preserving the prior schedule and results. -
Prediction-dependent noise: a
noise_model … = <family>, sigma = prediction_formula <expr>source whose σ scales with the simulated output (#495, ADR-0075). The honest combined additive+proportional error modelσ = σ_abs + σ_rel · y— whereyis the observable's predicted value — previously had no native form:formula(ADR-0044) evaluates only over free parameters, andrelative/column_mean(ADR-0031) read the data, not the simulation. The newprediction_formulaverb builds aPredictionFormulaSigmawhose symbols resolve either from the PSet (the estimated coefficients) or from the current simulation column of that name (a model species / observable / function), evaluated per scored point. Any new-era job may author it; PEtab import is one way to reach it. (Gradient-free score path only — a prediction-dependent σ raisesGradientNotSupportedon the #385 gradient/EFIM path, a later sub-layer.) -
Scale-preserving PEtab v1→v2 conversion:
pybnf.petab.petab1to2_preserve_scale. The officialpetab.v2.petab1to2drops the v1parameterScalecolumn (PEtab v2 removed it) and only warns — so aparameterScale = log10estimated parameter carrying no objective prior (the common case for a multi-decade kinetic parameter) converts to a linearuniform_varover the raw bounds: the same argmin, but a far harder, worse-conditioned optimization than the log10 search the modeler specified. This wrapper runs the standard converter and re-injects the dropped estimation scale in the v2-native form —priorDistribution = log-uniformover each such parameter's bounds — which PyBNF imports as aloguniform_varon the Log10 scale. Because the optimizer objective excludes the prior, this sets only the search scale and initial sampling, not the objective, so the fit stays the pure-MLE problem v1 specified; parameters petab1to2 already folded into a prior (parameterScale*Normal→log-normal, …) are left untouched, as are linear ones.import_jobstays a pure v2 importer — the conversion is an explicit, named step, not a reach-back to v1 in the read path. Intended as the opt-in migrationpetab1to2itself should offer. -
General-objective trust-region optimizer:
fit_type = gntr(ADR-0068, #481). Fills the last empty cell of the gradient-fitting (objective × curvature-model) matrix.trfgives a trust-region step with aJᵀJ(Gauss-Newton / empirical-Fisher) Hessian but only for an exact least-squares objective; the moment the objective stops being a pure sum of squares — an estimated noise scale, a Laplace / count likelihood, or an active constraint — the gradient path dropped tolbfgs(limited-memory quasi-Newton).gntrextendstrf's well-conditioned trust-region step to those general-NLL objectives: its Hessian is the expected-Fisher / Gauss-Newton informationH = Σ κᵢ sᵢsᵢᵀ(+ estimated-noise and constraint blocks), built from the same #385 forward sensitivitiessᵢ = ∂predᵢ/∂θplus small analytic per-family curvature factors (newNoiseModel.location_fisher/noise_param_fisherandConstraint.penalty_curvatureseams) — no second-order sensitivities. It consumes the same scalar gradient aslbfgs; only the curvature differs. Internally it reusestrf's Coleman–Li reflective machinery unchanged by feeding(g, H)through a ridge-regularised pseudo-Jacobian, so on a Gaussian least-squares fit it reduces totrf's step exactly. It runs natively in the distributed propose/score loop (picklable, norun()override, concurrentN-start multi-start, registered as a box-start refiner) like every otherfit_type. New config keysgntr_grad_tol(1e-8),gntr_step_tol(1e-8),gntr_ridge(1e-10), and the runtime-guardedgntr_max_iterations. This cut supports an estimated-σ Gaussian (chi_sq_dynamic), a fixed-scale Laplace, a fixed-dispersion mean-centered negative-binomial, and a Gaussian fit with static-hinge constraints; the coupled corners it cannot yet build the Fisher Hessian for (a mean-on-log estimated scale, a free-dispersion / median count family, an estimated Student-t df, or an estimated constraint scale) refuse with a pointer tolbfgs, which fits them.trf/lbfgsare byte-identical (they never form the Hessian). -
Kalman-inspired DREAM proposal:
proposal = kalman(ADR-0067, Stage 3; DREAM(KZS), #358). The third proposal operator on the unified DREAM engine (Zhang, Vrugt et al. 2020). During a burn-in window each proposal is steered toward the data by a Kalman gainK = C_ZY (C_YY + R)⁻¹built from the archive's parameter↔model-output cross-covariance, with the innovationd - f(xᵢ) + εtaken at the chain's current state (ε ~ N(0, R)), which accelerates burn-in on informative, mildly non-linear problems; after the window the chain reverts todefor a reversible sampling phase (the Kalman jump breaks detailed balance by design, so its samples are burn-in and discarded). The gain reads each archive entry's model output vectorf(Z)— surfaced by the newLikelihoodObjective.aligned_prediction_dataseam and carried in an output-augmented archive that turns on only for this proposal (the "implied axis 2b"; dormant and byte-identical forde/whitened).kalmanrequires a linear-scale Gaussian likelihood (chi_sq/chi_sq_dynamic, the source ofR = diag(σ²)) andn_try = 1, and refuses any other objective orn_try > 1before the run starts. The internal ensemble size is fixed (M = 20, clamped to the available archive, falling back todebefore enough outputs accrue — no new user key); one new proposal-scoped keykalman_burnin_frac(default0.3) sets the window as a fraction ofburn_in. Validated end-to-end against a closed-form linear-Gaussian posterior (f(x) = A xscored by realchi_sq), plus pinned gain-math and burn-in-switch unit tests. -
Multi-Try DREAM: the
n_trycount (ADR-0067, Stage 2; MT-DREAM(ZS), #357). A new integern_tryconfig key turns each chain-generation into a multiple-try step (Liu, Liang & Wong 2000; Laloy & Vrugt 2012): withn_try = k > 1a chain drawskcandidate proposals, selects one in proportion to its posterior importance weight, and accepts it over the current state with a multiple-try Metropolis ratio evaluated against ak - 1-point reference set drawn from the winner plus the current state (2k - 1evaluations per chain per generation). Multiple tries per generation raise the per-generation acceptance rate and help parameter-rich / strongly correlated posteriors mix. It is the second orthogonal axis of ADR-0067 and composes with everyproposalvalue (de,whitened) and with the snooker update — MT-DREAM(ZS) is literally multi-try parallel-DE.n_try = 1(the default) is the classic single-try engine and is byte-identical to before (verified against the DREAM/P-DREAM oracle suites and the effective-config goldens; the only change is the additiven_trykey). The snooker proposal is non-symmetric, so under multi-try its candidate and reference weights carry the ter Braak & Vrugt (2008) Jacobian||p - z||^(d-1); the current-state reference slot uses the current state's distance to the selected candidate's anchor — the unique choice that reduces to the published single-try snooker ratio atk = 1(derived from first principles and confirmed by a stationary-distribution test; both the DREAM-Suite and PyDREAM reference implementations differ on this term). The multiple-try acceptance is validated to preserve a known Gaussian target with the snooker update active. -
DREAM
proposaloperator key; P-DREAM folded into one DREAM engine (ADR-0067, Stage 1). DREAM(ZS) and Preconditioned DREAM are now oneDreamAlgorithmengine selected by a newproposalconfig key:proposal = de(default) is the classic parallel-direction proposal, andproposal = whitenedis the covariance-preconditioned proposal that used to be a separate algorithm. Thep_dreamjob type is unchanged for users — it is simplydreamwithproposal = whitenedpinned — andwhitenedcan now also be requested explicitly on adreamrun. This is a pure refactor:dreamat defaults andp_dreamare byte-identical to before (verified against the existing DREAM/P-DREAM oracle suites and the effective-config goldens). It is the first step of ADR-0067's unification of the DREAM family into two orthogonal axes (proposal×n_try), which will absorb the requested MT-DREAM (#357) and DREAM-KZS (#358) without new sampler subclasses. -
Composable floor normalization + analytic per-series scaling for relative / arbitrary-unit data (#479). Two composable, per-series normalization primitives so a log/relative objective on arbitrary-unit data (fluorescence, blots) can be spelled with standard tokens instead of a bespoke objective class. (1)
floor <rho>— an additive measurement-noise floorx' = x + rho*max(x)(defaultrho = 0.03) applied identically to the simulated and the experimental column, so a log objective stays finite where a series legitimately touches zero. (2)scale— analytic per-series optimal multiplicative scaling profiled out at scoring time (hierarchical / profiled scaling; Weber et al. 2011, Loos et al. 2018), family-appropriate: the geometric-mean ratio for a log family (lognormal) and the least-squares optimumc* = Σ w s d / Σ w s²for a linear one — so an overall model-vs-data scale difference is not penalized (no per-seriesscaleparameter needed). They compose as an ordered chain (normalization <obs> = floor 0.03, scale, per-observable /<exp>.<obs>/ whole-fit), and together withobjective = lognormalspell the exact sum-of-squared-log-differences-of- geometric-mean-normalized-trajectories objective of Jaruszewicz-Błońska et al. (PLoS ONE 2023; 18(6):e0286416). Legacynormalization = peak/normalization x = peakround-trip byte-identically;peak/init/zero/unitstay sim-only. Thepeak,unit, andfloorcolumn reductions are NaN-aware (np.nanmax/nanargmax, etc.), so a sparse multi-observable target — NaN in the rows where a given observable is unmeasured — is reduced over its measured points only rather than collapsing the whole column to NaN (which had silently zeroed the objective); a dense column is byte-identical. Both new primitives have a deferred gradient (they raiseGradientNotSupported, so a gradient fit falls back to a gradient-free step; the motivating fits are evolutionary), and both are refused on PEtab export (a whole-trajectory reduction has no pointwise PEtab v2 operator;scale'sobservableParametersmapping is a future direction). See ADR-0066. -
Gradient-based fitting extends to
parameter_scan(dose-response) objectives (#476). A gradient fit (fit_type = trf/lbfgs) can now target a dose-response objective, not just a time course. The default dose-response path already computed the per-dose forward sensitivities∂obs(dose)/∂θ— one sensitivity-configured ODErun()per swept dose — and then discarded them at row assembly; PyBNF now stacks those per-point final-row sensitivities down the dose axis into the scanData, so the existing gradient assembly producesd(objective)/dθfor dose-response fits. The swept dose is the data's independent variable (not a fitted parameter), so the per-dose sensitivity is well-posed and consumed exactly as a time-course row is. Supported for the reset-to-seed strategies — the parity / integrate-to-steady-state default and the independent fixed-time scan — on both the native BNGL and SBML/Antimony backends. Newton/KINSOL (ss_method=>"newton", now supported — see #478 below), continuation/bifurcate (reset_conc=>0),method=>"protocol", and carried-state (pre-equilibration, ADR-0062) scans refuse cleanly on the gradient path with an actionable message (an incidental, unscored scan of the same shape still runs sensitivity-free, #475). The scalar (metaheuristic) path is byte-identical. See ADR-0064. -
Scored Newton/KINSOL (
ss_method=>"newton") steady-state dose-response scans are now differentiable (#478). The KINSOL accelerator solves each dose point's steady state as an algebraicf(x)=0(no forward-sensitivity integration), so #476 (ADR-0064) kept a scored Newton scan gradient-free and pointed at the parity default. It is now a real speed win under a gradient fit: the KINSOL solve returnsdY_ss/dpexactly (the implicit-function-theorem derivative on the analytical Jacobian, not a finite difference), and bngsim ≥ 0.11.35 (lanl/bngsim#12) maps it through the observable/function Jacobian∂g/∂xand exposes it asSteadyStateResult.output_sensitivities, mirroring the CVODEResult. PyBNF stacks those per-dose slices down the dose axis exactly as the parity path does — no gradient-assembly change. On the gradient path the scan runs sequentially (the KINSOL sensitivity solve is kept off the thread pool) and the KINSOL→CVODE non-convergence fallback is itself differentiable and consistent with the converged path. Requires bngsim ≥ 0.11.35; a build lacking the accessor refuses a scored Newton scan cleanly with an upgrade hint (a scalar Newton scan is unaffected). Continuation/bifurcate,method=>"protocol", and carried-state scans still refuse on the gradient path. See ADR-0065. -
Edition-2 preincubate → wash → dose-response scan protocol (#474). The new-era
experiment:/condition:surface now expresses the full equilibrate → intervene → measure a dose-response protocol, so a published fit that needs it (the Erickson-2019 IGF1R competition/dissociation fit — 7 rate constants to 3 datasets, two of them a 2 h-preincubate → wash → cold-competition scan) runs inedition = 2with no in-model actions block. Two capabilities: (A) aparameter_scanmay be the measured phase of apreequilibrate:experiment — the synthesizer emitssaveConcentrations()+parameter_scan(… reset_conc=>1)so each dose resets to the carried post-intervention state; (B) acondition:'sperturbations:accepts a quoted BNGL species pattern target with a number or a parameter-expression value — a speciessetConcentration(a wash"IGF1(ds,hs,label~hot)" = 0, or a dose-tracking bolus"IGF1(ds,hs,label~cold)" = IGF1_cold_conc*(NA*Vecf)), vs. a parametersetParameter. The bngsim backend routes such a carried-state scan to its native reset-conc-to-snapshotparameter_scan/bifurcate(requires bngsim ≥ 0.11.34, lanl/bngsim#11), reproducing BNG2.pl exactly; the fresh-from-seed dose-response paths (ADR-0046) are unchanged. See ADR-0062. -
PEtab v2 export/import of the preincubate → wash → dose-scan protocol (#477). The two shapes ADR-0062 added to the edition-2 fitter now export to PEtab v2, import back, and round-trip byte-for-byte (validated by petab's full
default_validation_tasks): (1) a speciessetConcentrationcondition target — a BNGL species pattern is not a valid PEtab id, so it is aliased through the mapping table (petabEntityId→ the pattern) and the condition targets the synthesizedspecies_<…>id with a number or a parameter-expression value; (2) a pre-equilibrated dose-response — each dose becomes a two-period Experiment (atime = -infpre-equilibration period + a measurement period applying both the shared wash condition and a per-dose swept-parameter condition), the combination of ADR-0052 and ADR-0046. The exporter's previous "deferred" refusals are lifted. The surrogate split × a pre-equilibrated scan (an empty surrogate set M is required) and a whole-fitnormalizationtransform (the real Erickson-2019 IGF1R job) stay out of scope, raised in code. See ADR-0063. -
examples/real-world/— the 2019 PyBNF-paper case studies on the edition-2 surface. The biological models from Mitra et al. (iScience 2019) — Kozer's EGFR (ODE and network-free), the ligand/receptor model (ODE and NFsim), IGF1R competition binding, the FcεRI γ-chain SSA network, and the trivalent-ligand aggregation model — re-expressed on the new-eraexperiment:/condition:/data:config surface, spanning the three simulator paths (deterministic ODE, Gillespie SSA, network-free NFsim). These validate PyBNF's bngsim-backed default path on representative, paper-scale models (issue #380), withtests/test_real_world_examples.pyrunning a backend-free well-formedness tier in default CI and a real-bngsim end-to-end tier under-m recovery. -
Network-free (NFsim) options on the edition-2 experiment surface. A
method: nfexperiment now acceptsgml:(global molecule limit) andcomplex:(track molecular complexes) — the network-free counterparts ofatol/rtol— carried into the synthesized NFsimsimulate/parameter_scanso a large aggregating model (e.g. the EGFR clustering fit) can raise its molecule limit and track complexes as its classic hand-written action did. -
Fixed-time NF pre-equilibration (
equil_t_end:). Edition-2 pre-equilibration (ADR-0052) equilibrates to steady state, but NFsim has no steady-state solve. Amethod: nfpre-equilibration now takesequil_t_end: <time>and runs its (unmeasured) equilibration phase for that fixed duration instead; omitting it on the NF path is a clear config-time error rather than an unbounded run. ODE/SSA pre-equilibration is unchanged (still steady-state); any method may opt into a fixed-time equilibration with the field.
- A local fit now runs one single-threaded worker per core, whether or not
parallel_countis set (#526, ADR-0089). PyBNF built its local Dask client two different ways: withparallel_countset it pinned one thread per worker process, and without it took Dask's bareClient(), whose workers are multi-threaded on any machine with more than four cores — so whether two jobs could run concurrently inside one process depended on an unrelated key. The simulation backends hold process-wide state that is not thread-safe (bothdask-sshpaths already pass--nthreads 1, and a scored Newton scan is already routed sequentially for the same reason), and issue #525 caught the consequence: with noparallel_count, concurrent worker threads raced on bngsim's cached sympy→C printer and atrffit aborted before its first start, whileparallel_count = 4— nothing else changed — completed every iteration. A/B on that job (8 concurrenttrfstarts, noparallel_count, three runs per side): the old default failed 3/3 times, each time losing the forward-sensitivity column of a different scored observable; the new default completed 3/3 with no dropped column. Both local branches are now one branch that always pinsthreads_per_worker=1;parallel_countchooses the number of worker processes and nothing else. Total concurrency is unchanged (a 6-core machine goes from 3 workers × 2 threads to 6 workers × 1 thread), but a default run now uses more processes, so it holds more model copies — lowerparallel_countto reduce memory. Runs that already setparallel_count, and all cluster runs, are unaffected. gntrnow assembles each scored forward-sensitivity row once per objective evaluation (#488). Its scalar-gradient and expected-Fisher calculations previously repeated the same experiment/row/column walk and rebuiltd(prediction)/d(theta)independently. A shared scored- point iterator now feeds both accumulators in one pass; standalone gradient-only (trf/lbfgs) and Fisher-Hessian assembly APIs retain their existing results.- Edition-2 one-model +
condition:jobs now simulate only the scored(experiment, condition)diagonal, not the full{action} × {condition}cross-product (#484, ADR-0069). Under edition-2 Mechanism A the single model ran every synthesized action under everycondition:mutant, but only each experiment under its own condition is ever scored — so for N experiments and M conditions each objective evaluation ran N×(M+1) simulations to obtain N scored series and discarded the rest (e.g. the Miller et al. 2026 MEK-isoform job: 25 simulations for 5 series). PyBNF now records a per-model emit-set — the full output suffixes any consumer reads (the scoredexp_datadiagonal ∪ constraint homes/references ∪ postprocessing targets) — and each bngsim backend'sexecuteskips every(action, condition)pair not in it, so the cost is N simulations. Results are unchanged (only unscored pairs are removed; the scored objective is provably invariant), and pruning is gated on edition ≥ 2 and action separability (no hand-writtenbegin actionsblock mixed in), so legacymutant:, non-edition-2, and mixed-action jobs — and the BNG2.pl /.netsubprocess paths — are byte-identical. A consumer that references a pair no experiment produces is now a load-timePybnfErrorrather than a silent drop. This makes the #483amoutput_trajectorywrite-guard defensive (off-diagonal suffixes are no longer produced). New tutorial lesson47_condition_perturbationsis the reference Mechanism-A example.
- PEtab import now reads a
problem.yamlwhose table-file lists are unindented (a column-0- item), the shape the officialpetab.v2.petab1to2converter emits (#407). An externally authored v2 problem — e.g. anyBenchmark-Models-PEtabproblem converted from v1 — imported asproblem.yaml ... has no parameter_files, becauseread_problem_yaml's dependency-free hand-rolled scan treated a column-0 list item as a new top-level key and dropped it; only the two-space-indented list shape our own exporter writes was read. The section reset is now guarded onnot stripped.startswith('-'), so a column-0- itemappends to the current section — making the reader a strict superset of both list shapes (our indented output and petab's unindented output parse identically). Two regression tests cover thepetab1to2shape and the two-shape equivalence. - Adaptive MCMC (
am) withoutput_trajectoryno longer crashes on edition-2 one-model +condition:jobs (KeyErroron<action><mutant>suffixes) (#483). Anamjob that saves posterior-predictive trajectories (output_trajectory) over an edition-2 model withcondition:perturbations bound to two or more experiments aborted on the first accepted sample with e.g.KeyError: 'WTn78gMEK_pRDS', leavingsamples.txtwith only its header andconstraint_samples.txtempty. The sampler allocates one trajectory buffer per scored data-key (time_length: the diagonalWT,KOko, …), butgot_resultwrote every raw simulation suffix it saw. Under edition-2 Mechanism A (one model +condition:mutants) the single model runs every action suffix under every condition-mutant, sores.out[model]yields the full{action} × {mutant}cross-product — the first off-diagonal suffix (WTn78g) hit an unallocated buffer. Both theoutput_trajectoryandoutput_noise_trajectorywrite blocks now skip any suffix that was not allocated (i.e. is not a scored data-key), writing only the scored diagonal. Thedepath on the same model/condition/experiment setup was unaffected. Surfaced on the Miller et al. 2026 MEK-isoform qualitative-constraint + Bayesian-UQ job ported to edition-2 as one model + fourcondition:cell lines; sibling to the edition-2/aMCMC cross-model fix in #480. - Adaptive MCMC (
am) no longer crashes withburn_in = 1(ValueError: no field of name <parameter>). The adaptive-covariance seed fileparams_<chain>.txtwas given its column-name header only on theiteration == burn_in - 1write, which is unreachable whenburn_in = 1— the iteration counter is already incremented to ≥ 1 by the time the seed rows are written, soburn_in - 1 == 0never matched and the file was left headerless. Thenp.genfromtxt(..., names=True)seed read atiteration == burn_in + adaptivethen consumed the first data row as the header and failed on the first parameter name. The header is now emitted when the seed file is first created, independent ofburn_in; output forburn_in ≥ 2is unchanged. Surfaced while verifying the #480 fix on the MEK aMCMC example. - Bayesian samplers no longer crash on the first accepted move when
.propconstraints are attached (#480). An adaptive-MCMC / MCMC / DREAM job (fit_type = am/mh/dream) that carries constraints aborted on the first accepted sample withTypeError: 'NoneType' object is not iterable, most visibly with cross-model dotted references (WT.obs at time=t < KO.obs at time=t). The per-sample constraint-satisfaction bookkeeping read the acceptedResult.simdata, but the default worker-scoring path (local_objective_eval=0withparallelize_models=1) nullsres.simdataafter scoring and moves the full multi-model dict tores.out— soConstraint.penalty()receivedNoneand cross-model suffix resolution iterated it. The samplers now resolve the simulation data through a_result_simdatahelper that readsres.outon the worker-scoring path andres.simdataon the master-scoring path (parallelize_models>1), andevaluate_constraintsguards aNonedict into a graceful skip rather than a hard crash. The same fix restores the pointwise-log-likelihood (LOO/WAIC) sidecar, which was silently empty on the worker-scoring path for the same reason. Regression vs v1.1.9; verified end-to-end on the 5-model, 90-cross-model-constraintexamples/Miller2025_MEK_Isoforms/MEK_isoform_aMCMCjob — the sampler now draws posterior samples and writes per-sample constraint-satisfaction rows (samples.txt,constraint_samples.txt,constraint_satisfaction_*.txt), where it previously aborted before drawing a single sample. - Gradient fits no longer abort on an incidental non-differentiable action (#475). A
gradient-based fit (
fit_type = trf/lbfgs) enables a forward-sensitivity request on the whole model, and any action that cannot carry sensitivities forward — a stochastic (ssa/nfsim) diagnosticsimulate, or a carried-state pre-equilibrationparameter_scan(#474) — used to abort the entire fit, even when that action's output is never scored against data. The two guards (_sensitivity_request_kwargs,_scan_carried_state) now gate on whether the action's output is a scored gradient target: a scored non-ODE / carried-state action still refuses cleanly (its gradient genuinely cannot be supplied), while an incidental/unscored one runs on the ordinary sensitivity-free path. The gradient optimizer declares each model's scored suffixes (fromexp_data) in_setup_gradient_path, keyed per-instance by the mutant/condition suffix; ODE actions stay always-bearing so the persistent-simulator sensitivity continuity across carried states (#457) is untouched. - Edition-2 network-free (NFsim) experiments now run through the bngsim bridge. A
method: nfexperiment synthesized an action set that (a) began withresetConcentrations()— which the bngsim NF bridge rejects (NFsim re-seeds each run, so it is a no-op) — and (b) forcedgenerates_network=True, sending a network-free model (whose reaction network is unbounded) down the network-generation path. Both are now suppressed on the NF path, so an edition-2 NF experiment classifies as the NF bridge and routes towriteXML→BngsimNfModel, matching a hand-written NF actions block. Surfaced by the newexamples/real-world/NFsim examples (#380); ODE/SSA synthesis is unchanged.
qualitative_lossselector and logit penalty model (ADR-0060) — a new logit (softplus) qualitative-constraint penalty completes the hinge/probit/logit family, and a globalqualitative_loss = {auto|hinge|probit|logit}config key re-runs a.propset under any one family, coercing every constraint to it through a shared scale currency (a family authored in its own model round-trips to identity). The logit gradient rides the existing constraint-gradient path (no assembly change).- Estimable qualitative-constraint scale (ADR-0061) —
qualitative_scale = fit <param>promotes the logit scale (s) / probit tolerance (σ) from a fixed authored value to a fittable free parameter estimated jointly with the model parameters, globally tied across all qualitative constraints (one nuisance parameter, the identifiable case). Includes its closed-formd(penalty)/d(scale)contribution on the scalar gradient path, mirroring the estimated-noise pattern. - Online documentation on GitHub Pages — https://lanl.github.io/PyBNF/, built
from the Sphinx sources and deployed via GitHub Actions (interim host while Read the
Docs access is provisioned). New pronghorn logo/favicon and a populated
pybnf.algorithmsAPI reference.
- Packaging: the built wheel is now PyPI-uploadable. The
testsextra pinned petab to agit+URL, which setuptools wrote into the wheel'sRequires-Dist; PyPI rejects any upload whose metadata carries a direct (git+) reference. Reverted the extra to stockpetab>=0.8,<1— the sdist and wheel now passtwine checkwith zero direct references. The CI native-BNGL oracle still gets the fork via thesetup-pybnfaction's input, so there is no test-coverage impact. - Corrected typos in the fatal-error (
CancelledError) message, and migrated the in-code documentation links from readthedocs.io to the GitHub Pages URL.
- The Sphinx documentation build is warning-clean and now enforced with
-W(warnings-as-errors) in CI, so a malformed docstring or RST fails the docs job.
- HMC / NUTS reference sampler (
job_type = hmc, ADR-0059, closing #425's sampler item) — a gradient-based No-U-Turn sampler (blackjax NUTS) for differentiable targets, the reference against which PyBNF's simulator-path samplers are judged. It runs only on the analytical/bring-your-own surface (the named analytical menu,objective = expression, and the full 16-family prior set), which it lowers to JAX: anexpressionNLL goes sympy→JAX, every prior family gains alogpdf_jax, and a log-scaled or bounded parameter is mapped to an unconstrained space through an unconstraining bijection so NUTS samples on ℝⁿ and transforms back.jax/blackjaxare an optional extra, lazily imported (core stays dependency-free), and a simulator model is rejected with a pointed error — HMC is deliberately analytical-only, not a general fitter. New banana / multimodal / rotated-quartic stress geometries exercise the sampler. (#425, ADR-0059) - Bring-your-own & analytical objectives (ADR-0050, closing #425's objective item) — three fileless ways to name the objective directly in the
.conf, with no.bnglmodel and no.expdata required.objective = expression+expression = <PEtab-math>compiles an inline negative-log-likelihood over the declared free parameters (bind-by-name; PEtab arithmetic, so^not**) down to a numpy callable that is also fully HMC-differentiable via the sympy→JAX path.objective = callable+callable = module:func(orfile.py:func) hands scoring to an arbitrary Python function (gradient-free). Both bind experimental data withdata = f.exp, …: a callable receives a{name: Data}map, while a data-boundexpressionis evaluated per observation over the.expcolumns and summed (still differentiable end to end). A named analytical menu —objective = banana, a=1, b=100and its siblings (rosenbrock, rotated quartic, …) — supplies closed-form test targets inline with their coordinates bound by name and no.targetsidecar file. Documented in the newdocs/analytical_objectives.rst. (#425, ADR-0050) - Gradient-based optimizers (
job_type = trf/lbfgs, #386) — two deterministic local optimizers that consume the new analytic objective gradient (#385):trf, a Trust-Region-Reflective / Levenberg–Marquardt least-squares solver over the residual Jacobian with proper bound handling (#460), andlbfgs, a full L-BFGS-B (generalized Cauchy point + subspace minimization) over the scalar objective. Both support box-sampled concurrent multi-start (keep-best), a discrete-events pre-flight gate that refuses a model whose gradient would be wrong (#461), and settable-from-.conftunables (thetrf/lbfgs/powell_line_tolknobs are now registered). (#386, #385) - Analytic objective-gradient engine (
pybnf/gradient/, #385) — the sensitivity-and-gradient infrastructure the gradient optimizers (#386) and standalone profile likelihood (#446) stand on. Forward output-sensitivity tensors are preserved through net execution (#447) with free parameters routed to bngsim'ssensitivity_params/sensitivity_ic(#448) and assembled into the residual Jacobian and scalar objective gradient (#449). Coverage spans the whole objective surface: estimated-σ noise-scale columns (#451), log/lognormal scale (#452), trajectory-transform + normalization (#453), asymmetric/non-Gaussian families (Laplace, Student-t, mean-vs-median centering; #454, plus the MEAN-on-log-scale offset/noise coupling), constraint and qualitative/comparison penalties (#456), the SBML/Antimony measurement-model seam (#455), pre-equilibration/steady-state sensitivity continuity (#457), and the negative-binomial noise gradient via median CDF-inversion implicit differentiation (#458) — plus a Student-t exact sqrt-loss residual for LM/TRF (#459). (#385) - Standalone
profile_likelihoodjob type (job_type = profile_likelihood, #446) — likelihood-profile identifiability analysis as a first-class run: for each parameter it profiles the objective along a fixed grid, re-optimizing the others at each point through an exact inner path and an L-BFGS-B inner path (so it also profiles non-exact objectives). It emits profile plots and resumable per-point state, and parallelizes across parameters. (#446) - SBML/Antimony assignment-rule observables (#463–#465) — the measurement-model layer now resolves an observable defined by an SBML assignment rule by inlining the rule's right-hand side (#465), routes Antimony (
.ant) models through the SBML formula namespace (#463), and excludes assignment-rule variables from that namespace so they don't shadow species (#464). (#463, #464, #465) - AIC / BIC / AICc for likelihood fits — a fit scored with a proper (normalized) likelihood objective now reports the information criteria for the best-fit parameter set:
AIC = 2k − 2·lnL,BIC = k·ln n − 2·lnL, andAICc = AIC + 2k(k+1)/(n−k−1)(the last reportedn/awhenn ≤ k+1). Because the reported log-likelihood is the full normalized density (the same gate LOO/WAIC use, ADR-0056), the AIC is an absolute value comparable across noise families and data sets — the first-class form of the model-selection arithmetic the tutorial computes by hand. - Native BNGL PEtab-loader hardening (#437, #420) — the dependency-free BNGL reader behind PyBNF's PEtab lint/import path now joins line continuations, strips BNGL line labels (indexed and named), and drops the
molecules/rulesblock aliases so it matches BNG2.pl exactly, pinned by a corpus regression gate that differentials the reader against BNG2.pl; a CI leg now runs the native loader. (#437, #420) - Worked-example tutorial series + interactive notebooks — a 46-lesson tutorial catalog spanning the toolbox (optimizer bake-offs and local-optimizer contrasts, Bayesian uncertainty and the full sampler family, robust/count/relative/lognormal noise models, per-observable and column-joint profile objectives, PEtab v2 round-trips and the lint clinic, gradient fitting and profile-likelihood identifiability, checkpoint/resume, model selection, and BPSL model checking) plus an interactive Jupyter notebook collection for PyBNF + bngsim.
- Student-t (robust-regression) noise family (ADR-0058, closing the second half of #438 item 1 — item 1 is now fully done) —
noise_model = student_t, sigma = <source>[, df = <source>]gives the heavy-tailed, outlier-robust observation likelihood: anormalwith a tail-heaviness knobdf(degrees of freedom), where smalldfproduces fat tails that downweight outliers anddf → ∞recovers the Gaussian (the noise analogue of the robuststudent_tprior from ADR-0057, and Stan's/PyMC'sstudent_t(ν, μ, σ)). It is the first two-parameter noise family:sigma(scale) anddf(shape) are each independently sourced (fix_ata constant orfita free parameter), so a fit may estimate 0, 1, or 2 noise parameters — a fixed-dfrobust fit (justsigmafree), both free, or anything between.dfis the one parameter that may be omitted, defaulting to a fixed4(the standard Stan/Gelman robust default), sonoise_model = student_t, sigma = fit s__FREEis a complete robust fit; estimatingdfis weakly identified, so pairdf = fit nu__FREEwith a positive prior on it (thegamma/half_*families ADR-0057 added compose exactly here). The per-point NLL isscipy.stats.t.logpdf-exact:data_fit = (ν+1)/2·log(1 + z²/ν), thelog σnormalizer summed iffsigmais estimated, and thedf-block (−logΓ((ν+1)/2) + logΓ(ν/2) + ½log(νπ)) summed iffdfis estimated — whendfis fixed that block is a constant the sampler drops, whendfis free it is the term that keeps the fit honest, and either way it rides intolog_densityso LOO/WAIC (ADR-0056) see the complete normalized density. The noise engine generalized to source a mapping of noise parameters (was exactly one): a spec is now(family, {param: source}), each family declares its ownnoise_params(retiring the engine's parallel name table) plus a per-parameterparam_normalizerskeyed by name, and the objective gates each parameter's normalizer on its own source's estimated-ness — a backward-compatible extension (the single-parameter families gain only a declared name and an ignored trailing argument; their scores are byte-identical) mirroring ADR-0057's trailing-p3prior-carrier extension. Student-t is exposed only through thenoise_modelsurface (noobjective = student_ttoken), on the linear scale (it is symmetric there, solocation = meanandmediancoincide); on a log scale it has no finite mean (its tails are too heavy for anydf), solocation = meanthere raises and onlymedianis safe. PEtab v2 has no Student-tnoiseDistribution, so the family is PyBNF-native and not part of the PEtab round-trip. (#438, ADR-0058) - Eight new prior families + a three-parameter prior carrier (ADR-0057, closing the prior-family half of #438 item 1) — the batch univariate priors Bayesian modelers reach for, each a
scipy.stats-backed leaf inpybnf/priors/that self-registers and gets its{base}_var/log{base}_var/ln{base}_varkeywords for free (ADR-0010):half_normal/half_cauchy(the standard weakly-informative scale priors, one parameter — the underlying scale),beta(bounded[0,1], for fractions/probabilities),inv_gamma(the conjugate variance prior),weibull(lifetime/time-to-event),gumbel(extreme-value/max),logistic(a heavier-tailed Normal sibling), andstudent_t(the heavy-tailed robust prior — a drop-in for a Normal prior that tolerates outliers). Seven are pure two-or-fewer-parameter leaves usable on both the legacy positional*_varline and the new-eraparameter:record (e.g.half_normal_var = k__FREE 2orparameter: k, prior: beta, alpha: 2, beta: 5); each is oracled against its scipy distribution and inherits the log/ln scale forms and one-/two-sided truncation (ADR-0022/0047) automatically.student_tis the exception and the design content: a useful Student-t prior wants three numbers (df,location,scale— the same knobs as Stan's/PyMC'sstudent_t), but PyBNF's prior carrier was hardwired to two (p1/p2). The carrier now extends to a trailingp3(FreeParameter,build_prior, everyPrior.build, the record builder), threaded throughset_value/__eq__, with no behavior change for any existing family (the third slot defaults toNone). Because a three-token positional*_varvalue already means a bounded box plus itsb/uflag,student_t(anyn_params >= 3family) is authored only through the new-eraparameter:record —parameter: x, prior: student_t, df: 4, location: 0, scale: 2.5— and is omitted from the positional grammar (var_keyword_grammar), staying in the keyword map so the record path resolves it. A family's ownscalefield is distinct from the record'sparameter_scaletransform, so the two never collide. The student_t noise family (the other bullet of #438 item 1) and the architectural non-goals (multivariate/joint priors, constrained parameter types) remain out of scope. (#438, ADR-0057) - LOO/WAIC via a
log_likelihoodgroup (ADR-0056, closing #438 item 4) — a Bayesian fit done withoutput_inference_dataand a per-point likelihood objfunc (chi_sq/chi_sq_dynamic/lognormal/laplace/neg_bin/neg_bin_dynamic, or theobjective/noise_modelsurface) now gets alog_likelihoodgroup in itsInferenceData, soaz.loo(PSIS-LOO-CV) /az.waic/az.comparework directly — model comparison from pointwise log-likelihoods, the Stanlooecosystem, for the cost of not discarding a decomposition PyBNF already computes. The pointwise log-likelihoods are recorded during the run, not re-simulated: at each accepted draw the per-observation densities are a cheap re-walk of the simulation already in hand (zero extra simulations; mirrors how constraint satisfaction is cached at accept and written at each sample), streamed to a newResults/log_likelihood.txtsidecar row-aligned withsamples.txt(one row per saved sample), which the bridge reads in lockstep to build the group (variableyover a labelledobs_idaxis, dimschain × draw × obs). The recorded values are the noise family's complete, normalized, unweighted per-point log-density (scipy.stats-exact:norm/lognorm/laplace.logpdf,nbinom.logpmf) — a newNoiseModel.log_densityrestores the parameter-independent constants the objective legitimately drops for sampling (Gaussian's½log(2π), and a log-scale family's change-of-variables Jacobian via the scale'slog_abs_dforward), so absolute WAIC/LOO and cross-family comparison are correct, not only same-family deltas; weights are a fitting device, not part of the generative likelihood, so they are excluded. The values therefore do not sum back to-score— they are the honest densitiesaz.looneeds. Gating reuses the one keyoutput_inference_data(no new key); with a non-likelihood objfunc (least-squares,kl,direct_pass, …) there is no normalized density, so the recorder is a no-op, the group is omitted, and a one-time note explains LOO/WAIC needs a likelihood objfunc. Note arviz 1.x dropped top-levelaz.waic(PSIS-LOO supersedes it) — the group powersaz.loo/az.compareon both arviz lines andaz.waicwherever a user's arviz still ships it. A run finished without the sidecar (key off, or pre-existing) simply yields no group; LOO is offered exactly where the data for it exists.prior/observed_dataremain deferred. (#438, ADR-0056) - ArviZ
InferenceDatabridge (ADR-0055, closing #438 item 3) — a documentedpybnf.inference_data.from_pybnf(source)maps a finished MCMC run's saved samples onto an ArviZInferenceData, so PyBNF's posterior output (am/dream/p_dream/pt/mh) becomes first-class in the ArviZ / bayesplot / loo ecosystem — trace/rank/forest/pair plots,az.summary,az.compare— for nearly free (PyBNF already runs the samplers, writesResults/samples.txt, and computes rank-normalized split-R-hat + bulk/tail ESS; this is a format bridge, not new statistics).sourceis aResults/directory, an output directory, or asamples.txtfile: the chain×draw shape is recovered from theiter<draw>run<chain>sample names (chains = the distinctrun<c>count =population_size), theposteriorgroup carries one variable per parameter andsample_statscarrieslp(the log-posterior). A log-scaled parameter is emitted in its sampling space (log10/ln, named e.g.log10_k) — the space PyBNF samples and diagnoses in — so ArviZ's recomputed diagnostics share PyBNF's parameterization and Vehtari method; scale is taken from the live parameters (auto-emit) or recovered from the.confcopied intoResults/(standalone), falling back to natural-space-with-a-warning on an archived run whose config can't be reconstructed. Theposterioris the saved sample (samples.txt: thinned bysample_every, post-burn-in — the same drawscredible*.txt/histograms use), so ArviZ recomputes diagnostics on fewer draws than the densediagnostics.txt: R-hat is comparable,az.essreads lower by design (PyBNF's own final R-hat/ESS ride along in the object's attributes; lowersample_everyfor denser ArviZ diagnostics). The new MCMC-only config keyoutput_inference_data = 1also auto-writesResults/inference_data.ncat run-end (the same builder, via the live parameters), mirroring the_emit_best_fit_bnglartifact hook.arvizis an optional extra (pip install pybnf[arviz], uncapped), lazily imported with a clear install hint so core stays dependency-free; a missing extra is a logged no-op, never fatal. The bridge supports both arviz major lines — the classic 0.xInferenceDataand the 1.x xarray-DataTreerewrite (they differ only in the onefrom_dictconstruction call, which the builder branches on), so installing it never downgrades a user's arviz and CI exercises whichever resolves.log_likelihood(→az.loo/az.waic),prior, andobserved_dataare deferred to the #438 item-4 follow-on that rides on this bridge. (#438, ADR-0055) - Self-contained best-fit BNGL: smooth curve + inline data (
edition >= 2, ADR-0054, closing the smooth-curve item of #444) — the end-of-runResults/<model>_bestfit.bnglartifact (ADR-0048) can now plot as a smooth curve and self-contain its data in one file. In the new era a fitting job's output times come from the data, so the artifact reproduces a ragged trajectory (only the measured instants); the new tool keysmooth_plot_points = Nre-renders each data-derived time-coursesimulate(...)onto a uniform N-step grid over[t_start, t_max]instead of the data'ssample_times, so running the artifact yields a smooth plot curve. This is byte-identical to the uniform form PyBNF already emits when output points aren't data-derived (method/t_start/suffix/conditionsetParameters preserved), touches only the post-fit artifact copy (the fit already scored on the data grid — the objective is unaffected), and is cross-engine (BNG2.pl + bngsim); parameter-scan actions (a swept axis, not time) and the steady-state pre-equilibration phase are left untouched. Separately,embed_best_fit_datanow embeds each time-indexed observable's experimental data inline as atfun([t...],[y...], time)reference function (was a sidecar.tfunfile under ADR-0048), so the artifact is a single self-contained file with no_bestfit_tfun/directory. ADR-0048 chose the sidecar form when the inline form was unexercised; bngsim 0.9.55 now supports inlinetfunnatively (verified end-to-end through the bngsim bridge), and since BNG2.pl 2.9.3 parses notfunform (inline or file), the switch is engine-neutral and strictly better for self-containment — the embedded-data overlay is read through a bngsim path either way. (#444, ADR-0054) - New-era per-observable normalization (
edition >= 2, ADR-0053, closing the preprocessing-keys item of #444) —normalizationnow keys by observable on the new-era surface, never by filename, fixing a hard crash. ADR-0028 keys data by experiment name, so the legacy filename-keyed per-file form (normalization = peak: alpha.exp) raisedKeyError: Noneunderedition >= 2(the filename stem is no longer the data key). Normalization is a per-observable prediction transform — a sibling of the per-observablenoise_model/cumulativesurface (ADR-0021/0051) — so it now takes the same shape: a whole-fit defaultnormalization = <type>, a per-observablenormalization <observable> = <type>(every experiment), and a per-(experiment, observable)overridenormalization <experiment>.<observable> = <type>. The three layer into a single most-specific-wins rule (a strict total order:<exp>.<obs>><obs>> default), so there is no tiebreak; a column matched by no rule is left un-normalized, and a target naming an unknown observable/experiment raises (a typo guard, like theobservable:override). The two new forms ride a('normalization', target)structural key (ADR-0014) and compile down to the existing{data_key: [(type, [columns])]}representation, so nothing below the config layer changes. The legacy filename form is refused underedition >= 2(redirecting to the per-observable form) and kept byte-identical under the legacy edition. Normalization has no PEtab v2 representation (a whole-trajectory reduction, not a pointwise observable formula), so the exporter now fails loud on any normalization (_reject_normalization, beside_reject_cumulative) rather than silently scoring the raw columns. The other three #444 preprocessing keys —smoothing,ind_var_rounding,constraint_scale— are global scalars, not filename-coupled, and ride the new-era surface unchanged (now covered by a test). (#444, ADR-0053) - PEtab v2 importer read path (BNGL-native; ADR-0032, closing the two-adapter proof at the read level) —
pybnf.petab.import_jobis the inverse ofexport_job: it turns a BNGL-native PEtab v2 problem (problem.yaml+ its TSV tables + the BNGL model) back into a runnable new-era (edition = 2).confplus its.expdata files and a fit-instrumented model copy. The reverse asset mappers run backwards onto the shared neutral rows — measurements pivot long→wide (oneDataperexperimentId, the_SDcolumn rebuilt fromnoiseParameters), conditions undo the surrogate-base<p>__REFrename (a base pin dropped, a surrogate relative op recovered, a fixed param's precomputed op recovered as an absolute set, the synthesizedcond_wildtypemapped back to a wildtype experiment), the objective token recovered from the observables' noise columns (chi_sq/sos/sod/ave_norm_sos), and the model's__FREEmarkers re-added — so the problem (parameters/priors, observables/noise, measurements, conditions/experiments) is recovered exactly and round-trips byte-for-byte through a re-export. PEtab is a problem spec; PyBNF is a job spec: the run-recipe is supplied, not recovered and is excluded from that identity —import_job(problem, out_dir, job_type='de', method='ode', method_overrides=None, settings=None), withmethodemitted per-experiment (never a global knob; round-trip-lossy, so a stochastic model does not survive a PEtab hop) and recipe defaults coming from the schema/registry.job_type='all'emits one runnableimported_<jt>.confper registered optimizer + sampler (the ADR-0012 benchmark-harness pattern; thecheckchecker excluded), so the importer covers the whole toolbox and a new method is importable with zero importer changes. Dependency-free + simulator-free (stdlibcsv+pybnf.data.Data;problem.yamlhand-parsed;petabstays a test-only oracle), so it runs in the bngsim-less CI tier. The documented PEtab/PyBNF boundaries mirror the export side and raise (SBML model, the five unsupported prior families, aneg_bin/log-normal/log-laplaceor expression noise model, replicate rows, multi-model, parameter-scan); fitting an imported job is gated on the ADR-0028 config loader (#423). (#407, ADR-0032) - PEtab v2 export reads the new-era surface (ADR-0028, completing the new-era contract) — the PEtab v2 exporter (
pybnf.petab.export.export_job) now reads a job's data, conditions, and observables directly from the new-era surface (model:/experiment:/data:/condition:/observable:), so export is a transcription: anexperiment:becomes a PEtab Experiment (its name theexperimentId; itsdata:files become measurement rows — multiple files are replicates, repeated rows under the one experiment), acondition:becomes a PEtab Condition (a fit-and-perturbed parameter handled by the surrogate-base<p>__REFrename of ADR-0027, generalized so a condition shared by several experiments emits its rows once), and anobservable:renames a data column before classification. The exporter is now new-era only ("refuse legacy everything"): under a modern edition it refuses a legacy data linkage (model = X : Y.exp/mutant/param_scan), directing the user to the new surface — the gate is on the exporter alone; the fitter still runs legacy confs unchanged. Dose-response (parameter-scan) export stays deferred together with its authoring surface, whose simulation endpoint time has no home in theexperiment:grammar yet (#426); a parameter-scan experiment raises that deferral. Every exported fixture passes petab's fulldefault_validation_tasksviaProblem.from_yaml+ the nativeBnglModelloader (ADR-0026), andexamples/demo/demo_bng_v2.confis now a fully new-era, exportable twin of the demo (withexamples/demo/parabola_v2.bngl, the demo model without abegin actionsblock, since the action is synthesized from the experiment). With this ADR-0028 is Accepted. (#407, #423, ADR-0028) - New-era
observable:column-header override (edition >= 2, ADR-0028) —observable: <entity>, column: <header>remaps a data-file column header to a model observable/function name when the two differ. By default a.expcolumn header is the model observable name and the objective matches experimental columns to simulation columns by that name, so this line is needed only when the measured column is named something else (common with real data) — without it a differently-named data column has no matching simulation column and the fit raises (_check_columns). The override renames the<header>column to<entity>(and its<header>_SDper-point noise companion, ADR-0021, to<entity>_SD) in every experimental data file, so the by-name match succeeds; the rename rewires both column maps in place and leaves the data array untouched. Scope is global (a top-level line, not per-experiment): a data file that doesn't contain<header>is left unchanged, while a<header>present in no data file is treated as a typo and raises (listing the columns actually present). The independent-variable column cannot be remapped, and a remap colliding with an existing column raises. Requiresedition >= 2; legacy and same-named confs are byte-unchanged, and the('observable', …)structural key passes through config building so golden configs stay byte-identical. With this the full new-era problem surface (job_type+model:+condition:+experiment:/data:+observable:+ parameters + objective) is complete. (#423, ADR-0028) - New-era
experiment:/data:syntax (edition >= 2, ADR-0028) — a named simulation bound to its measurement files, a PyBNF Experiment = a PEtab v2 Experiment:experiment: <name>, data: <f1.exp>[, <f2.exp>…]plus optionalcondition:,model:,type:, andmethod:fields in any order. The experiment name replaces the legacy filename→suffix convention as the simulation's identity, so the data↔simulation link is stated, not inferred from filenames, and a data file can be named anything. Two long-standing warts go away: multipledata:files are replicates (their rows stack into one experiment — not averaged, which is smoothing — so the objective sees every replicate measurement, impossible on the legacy surface without pre-averaging), and the simulation outputs at exactly the data's points (the data's independent-variable column supplies the output grid; PyBNF synthesizes thesimulateaction via BNGLsample_times/ RoadRunnersimulate(times=…), so the BNGLbegin actionsblock is no longer needed for fitting and the scoring grid always lines up with the measurements).condition:applies a named condition (omitted ⇒ wildtype);type:is inferred from the data (timecolumn ⇒ time course) and stated only when inference can't decide. A different front-end, the same internal objects — a new-eraexperiment:produces the sameself.modelssuffixes /exp_data/mappinga legacymodel = X : e.exp+time_coursedoes. Currently time-course experiments only; a parameter scan via this surface is deferred (its simulation endpoint time has no home in the grammar yet) and raises a clear error. Requiresedition >= 2; legacy confs are byte-unchanged. (#423, ADR-0028) - Negative-binomial median centering (
location = median/noise_location = medianon aneg_binnoise model; #419, ADR-0031) — completes ADR-0031's "every means every": the prediction can now be interpreted as the count distribution's median (its 0.5-quantile), not only its mean. Because the negative binomial is parameterized by its mean and its median has no closed form, the mean placing the continuous median at the prediction is recovered by a per-point bounded CDF inversion (scipy.special.betainc+scipy.optimize.brentq); the continuous 0.5-quantile is used (not the discreteppfstep) so the objective stays smooth for the optimizers. The legacyneg_bin/neg_bin_dynamicobjfuncs remain frozen-mean and byte-identical. (#419, ADR-0031) - Modern objective surface (
edition >= 2, ADR-0031) — three keys replace the legacyobjfunc, which is now an error under a modern edition:objective(the named per-point catch-all —sos/chi_sq/laplace/neg_bin/ … plus the barescorepassthrough), a whole-fitnoise_modelline (noise_model = <family>, …, no observable — the recommended per-point form), andprofile_objective(column-joint shape objectives:kl, and a new workingwasserstein1-Wasserstein / earth-mover distance). Under a modern edition exactly one must be named — there is no implicit default. The legacy least-squares objfuncs fold into the per-point noise-model engine: each token desugars to the equivalentnoise_model(objective = sos≡gaussian, sigma = fix_at 1;sod≡laplace, sigma = fix_at 1; …), restoring the statistically-proper ½ that legacysos/norm_sos/ave_norm_sosdrop (argmin-identical — the located fit is unchanged). Two newnoise_modelσ-sources enable the fold:relative [<cv>](constant-CV, σ ∝ the measurement — the honestnorm_sos) andcolumn_mean(σ = the observable's column mean — the honestave_norm_sos). The legacy edition and theobjfunckey remain byte-identical to before. (#424, ADR-0031) - New-era
condition:syntax (edition >= 2, ADR-0028) — a named set of parameter perturbations on a base model,condition: <name>, perturbations: <var op val>, …(=sets absolutely;* / + -apply relative to the nominal value), with an optionalmodel:ref (omittable when the job declares one model, required under several). A condition is a PyBNF Mutant = a PEtab v2 Condition; it is the perturbation half of the legacymutantline, carrying no data binding (data is introduced separately, via an experiment). Internally it reuses the existingMutation/MutationSet/add_mutantmachinery — acondition:produces the identical MutationSet a legacymutant … : nonewould, minus the suffix-matched data coupling. Duplicate condition names are rejected at parse time. (#423, ADR-0028) - New-era
model:declaration syntax (edition >= 2, ADR-0028) — under a modern edition a model is declared with the colon formmodel: egfr.bngl(or a comma listmodel: egfr.bngl, erbb2.bngl), which carries no data binding: data is introduced separately (through an experiment's measurements, landing in a later chunk), retiring the legacy coupling of data onto the model line.model:lines are repeatable and accumulate; themodelIdis the filename stem, unique across all declarations. Internally each declared file folds to exactly what a legacymodel = file : noneline produces, so the model loader and everything downstream are untouched (a different front-end, the same internal objects). The legacymodel = … : …form is unchanged and still works at every edition. (#423, ADR-0028) fit_type→job_typerename (edition >= 2, ADR-0028) — under a modern edition the run-selector key is namedjob_type, becausefit_typewas a misnomer: the key chooses across point-estimate optimizers (de/ade/pso/ss/sim/powell/cmaes/sa), Bayesian samplers (am/dream/p_dream/pt/mh), and the model checker (check) — not just fitting. The value still names the specific procedure; the key now honestly names the kind of job. This is a surface-only rename: the config layer normalizes the chosen key into the internal slot, so the registry and every downstream read are untouched. Under a modern edition the legacyfit_typekey is rejected and, like the modern objective surface, there is no implicit default — the run must be named. The legacy edition keepsfit_type(defaulting tode) byte-identical to before. (#423, ADR-0028)editionconfig key — an optional integer that opts a.confinto a frozen set of modernized PyBNF conventions. Editions are select-and-freeze (in the Rust-edition sense): a config written foredition = 2is interpreted under edition-2 conventions forever, even as later releases change other defaults under higher editions, so upgrading PyBNF never silently reinterprets an existing config. Omitting the key selects legacy behavior (the implicit edition 1), byte-identical to PyBNF's historical defaults; the newest syntax must opt in with an explicitedition. An unsupported (future) edition is rejected with the PyBNF version it requires. The first behavior it gates: under a modern edition (edition >= 2) the universal default prediction centering is the median (consistent with PEtab v2) — byte-identical for the location-scale noise models (chi_sq/lognormal/laplace, already median), and now also realized forneg_bin(legacy default mean), whose median has no closed form and is solved per-point (#419); aneg_binfit with no explicit location resolves to the median and warns (setnoise_location = meanto keep the legacy mean, or= medianto silence). (#424, ADR-0031)- Truncated priors — the unbounded-support prior families (
normal_var,laplace_var, and theirlog*forms) now accept finite reflecting bounds, turning them into truncated priors. The prior is renormalized over the box and sampled inside it (truncated inverse-CDF), and the reflection fold that keeps MCMC proposals in-box — previously available only to theuniformfamilies — now applies. Internally this is a family-agnosticTruncatedPriordecorator inpybnf/priors/, with theFreeParameterowning the box. This unblocks faithful import of the common PEtab v2 pattern of anormalprior with finitelowerBound/upperBound: the PEtab importer now maps such a two-sided truncation to a boundedFreeParameterinstead of raising. One-sided truncation (a single infinite bound) is still unsupported and raises with a clear message. (#411, ADR-0020) - Official support for Python 3.13 and 3.14. CI now tests every supported version (3.11–3.14).
- Parameter-recovery test tier (
pytest -m recovery, opt-in) — synthetic-data parameter recovery for tiny ODE models (exponential decay, logistic, Lotka–Volterra, SIR) fit through the real bngsim backend: each model is simulated at known-true parameters to generate a zero-noise data file, then a real fit (DE→Simplex refine, plus theamsampler) must recover them. This exercises the simulate→score→propose loop end to end with a genuine engine, complementing the analytical integration tiers (which use no simulation backend). Needs bngsim and BNG2.pl; auto-skips otherwise, so it never runs in hosted CI. Seetests/README_integration.md.
- Raised the minimum Python to 3.11 (was 3.10), aligning with the scientific-Python ecosystem — the latest numpy and scipy require Python 3.11.
- Dropped the upper version caps on
paramiko,msgpack,libroadrunner,numpy, andscipyso installs track their latest releases (pydantic,pyparsing, andbngsimstay capped).
- Python 3.10 support, and the
tomlitest dependency it required (the standard-librarytomllibis available on 3.11+).
- ArviZ bridge for
am—pybnf.inference_data.from_pybnfnow reads Adaptive_MCMC's per-chain draws, so theInferenceDatabridge (ADR-0055) works for anamrun and not only thedream/p_dream/pt/mhsamplers. - Dask future scattering — scattered
Futures are passed toclient.submitas keyword arguments rather than asJobattributes, fixing a distributed-scheduler failure on scattered model lists. - Bootstrap replicate refinement — a bootstrap replicate is now polished by the refine step and gated on the refined objective, and a retry resamples afresh rather than reusing the failed draw.
- Initial-condition-only free parameters — a free parameter that appears only in a species initial condition now actually moves the simulation: the bngsim bridge re-derives species ICs in
execute(#450). - Orphan
_SDcolumn — the error for a per-point noise column with no matching observable now names the estimated-noise-scale cause instead of failing opaquely. - Loud CLI failure — running the package as
python -m pybnf.pybnfnow fails with a clear message instead of misbehaving on the relative import. - Multi-model
condition:round-trip (ADR-0041 addendum, closing #444 item 4) — a multi-model PEtab job whose experiment applies a namedcondition:now round-trips. The exporter and fitter already handledcondition: <name>, model: <file>(the fitter attaches the condition'sMutationSetto that model and requires themodel:ref under more than one model), but the importer emitted the reconstructedcondition:line with nomodel:field, so the re-imported multi-model conf failed to load withCondition '<name>' does not name a model, but the job declares N models. PEtab conditions are model-agnostic (nomodelIdcolumn — the model↔data link lives on the measurements, ADR-0041), whereas a PyBNF condition belongs to one model, so the importer now recovers each condition's owning model from the experiment that applies it (viacondition:orpreequilibrate:) and emits themodel:field under multiple models; single-model jobs stay byte-identical. A PEtab condition referenced by experiments on different models has no PyBNF representation (a condition can't span models) and is refused with a clearNotImplementedError. The byte-equal export→import→re-export identity is preserved (a condition'smodel:field doesn't alter the model-agnostic PEtabconditions.tsv). (#444, ADR-0041)
- Powell and CMA-ES optimizers — two native, derivative-free black-box optimizers, usable both standalone (
fit_type = powell/cmaes) and as the post-fit refinement step. PyBNF now offers three refiners; choose one with the newrefine_methodconfig key (sim(default, Nelder–Mead Simplex),powell, orcmaes) whenrefine = 1. Powell uses conjugate-direction parabolic line searches; CMA-ES is a population-based covariance-adapting evolution strategy, robust on ill-conditioned objectives. No new dependency (#403) - CMA-ES box / global-start mode —
fit_type = cmaesnow also accepts boundeduniform_var/loguniform_varpriors instead of avar/logvarstart point. Given a box, CMA-ES runs as a standalone global optimizer: it starts at the box center, seeds its covariance with the per-coordinate box widths (so the first generation spans the whole box), and repairs candidates into the box — no start point required, the population-optimizer ergonomics ofde/psowith covariance adaptation. In box modecmaes_sigma0is read as a fraction of each box width (default 0.3); in point-start / refine mode it remains the absolute initial step. Refinement (refine_method = cmaes) is unchanged. No new config key (#404, ADR-0017) rotated_gaussiananalytical target (full covariance matrixSigma, NLL0.5 (x-mu)^T Sigma^{-1} (x-mu)) for the in-process integration harness, pluspowell/cmaesrecovery tests on a rotated, ill-conditioned bowl. The correlated (non-separable) objective exercises Powell's conjugate-direction update and CMA-ES's covariance adaptation — paths the axis-aligned (separable) Gaussian target leaves untested (#405)rotated_quarticanalytical target (k1 r1^4 + k2 r2^2, a smooth, non-separable, non-quadratic, trap-free curved valley) for the integration harness, used to test Powell's bracketing+Brent line search where the old fixed-step parabola stalled. The rotated Gaussian (quadratic) cannot discriminate, since a parabola fits a quadratic exactly (#406)- BNGsim in-process simulation bridge — optional bngsim backend for BNGL models, avoiding subprocess BNG2.pl on every fitting iteration. Supports ODE, SSA, PSA, and NFsim methods with codegen ODE RHS compilation
- BNGsim SBML backend via bngsim's SBML loader
- BNGsim Antimony backend via bngsim's Antimony loader
- BNGsim NFsim backend for network-free BNGL simulation
- Hybrid BNGL path: models combining
generate_network()withsimulate({method=>"nf"})now run BNG2.pl once for network generation, then use in-process NFsim for all fitting iterations - BNGsim
parameter_scansupport for time-course, steady-state, and protocol scan modes - BNGsim
parameter_scansteady-state solver with automatic fallback to long time-course when the solver does not converge - Threaded steady-state and batch time-course parallelization in
parameter_scan - BNGsim protocol execution:
begin protocol/end protocolblocks with multi-step simulate,setConcentration,saveConcentrations,resetConcentrations,setParameter,saveParameters,resetParameters, method switching, andstop_ifsupport method=>"protocol"support inparameter_scanfor executing protocol blocks at each scan pointcontinue=>1flag for multi-phase simulations with model time trackingstop_ifconditional early stopping in simulate actionsatol/rtol/seedpassthrough to bngsim simulatorprint_functionscontrol for observable selection- Bifurcate action support (
reset_conc=0) - Safe expression evaluation in action arguments
addConcentrationsupport in network-backed NFsim path- Species IC re-evaluation from
.netexpressions - Table function support (file-based and inline) for network-backed models
- Constraint satisfaction reporting for Bayesian samplers: after MCMC runs, a summary file reports the percentage of posterior samples satisfying each constraint (#324)
- Formal EBNF grammar for BPSL in the documentation (#271)
max_failed_simulationsconfig key to control early abort threshold (#146)random_seedconfig key to seed and log PyBNF-side random number generation (#31)- Command-line options reference in documentation
- BNGsim package dependency (
bngsim>=0.5.0) and optional Antimony install extra (#372) bngl_backendconfig key for BNGL backend control:auto,bionetgen, or requiredbngsim(#371)stochastic_seedconfig key for BNGsim stochastic simulations (auto,auto_honorbngl,random,random_honorbngl); under the defaultauto, PyBNF derives deterministic per-action seeds from the evaluation context so re-evaluations of the same parameter point reproduce, smoothing replicates yield distinct trajectories, and explicit BNGLseed=>Narguments are overridden with a warning. Covers SSA, PSA, NFsim, RuleMonkey, and SBML/Antimony stochastic backends (#373)
- Powell's line search robustified to bracketing + Brent (ADR-0016): each 1-D line minimization now brackets the minimum (geometric expansion from
±powell_step) and refines it with Brent's method to the newpowell_line_tol(default1e-4), instead of the fixed-step parabola. It follows long, curved, non-quadratic valleys where the old fixed step stalled, and is confined to the parameter box so refining a bounded fit finds a minimum that lies past a bound on the boundary. The search is now fully serial (one objective evaluation per step; Powell no longer evaluates the two±probes concurrently — CMA-ES is the parallel derivative-free optimizer), and a convergence-stop guard ensures Powell never quits before its conjugate-direction update has run.powell_stepkeeps its key but now means the initial bracketing step. Powell now also solves the Rosenbrock/banana valley, a #403 non-goal. State stays picklable so backup/resume are unchanged (#406) - Simulated annealing (
fit_type = sa) rewritten as a true optimizer (ADR-0008): it now minimizes the raw objective function instead of the posterior (prior + likelihood). Foruniform_var/loguniform_varpriors this is a no-op — the prior was a constant inside the box that cancelled in the acceptance ratio, with proposal reflection enforcing the bounds — but fornormal_var/lognormal_varpriors results change:sano longer acts as a silent MAP estimator, aligning it with every other PyBNF optimizer (de/pso/ss/sim), which use the prior only for the initial random draw.sais extracted to its own class (optimizers/simulated_annealing.py) with a standalone config; the sampler-onlystarting_params/continue_runstart paths no longer apply to it.saremains deprecated. - Supported BNGL network and NFsim simulations now auto-select BNGsim by default when available;
PYBNF_NO_BNGSIM=1keeps the legacy BioNetGen path (#371) - BNGL
method=>"nf"routes to BNGsim's vendored NFsim andmethod=>"rm"to vendored RuleMonkey; PyBNF now delegates network-free method normalization and capability detection to bngsim's publicnormalize_method()/HAS_NFSIM/HAS_RULEMONKEYsurface instead of maintaining its own alias tables. Missing vendored backends surface bngsim's "recognized but not present in this install" message. PyBNF no longer carriesnf_exact/nf_fixed/dynstoc/dsas first-class aliases; bngsim's normalization governs their acceptance. Requiresbngsim>=0.5.0(#377) - Modernized packaging metadata in
pyproject.toml, added dependency upper bounds, documenteduvinstallation, and refreshed the Dockerfile with Python 3.12 and BioNetGen 2.9.3 (#360) - Minimum supported Python version is now 3.10 (#372)
- Replaced nose test dependency with pytest
- Demoted high-frequency per-iteration log messages from INFO to DEBUG to reduce log file size (#173)
- Bayesian parameter priors and initial sampling now use shared
scipy.statsdistribution objects; normal and lognormal prior log-probabilities include SciPy's normalization constant while MCMC acceptance ratios are unchanged (#5) - BNGsim stochastic simulations (SSA/PSA/NFsim/RuleMonkey, plus SBML/Antimony SSA) now use deterministic context-derived seeds by default; trajectories from re-runs of the same parameter point reproduce bit-for-bit. Set
stochastic_seed = randomto restore the previous wall-clock-style randomization (#373) - PyBNF-side random number generation migrated from NumPy's legacy global RNG (MT19937) to a per-algorithm
numpy.random.Generator(PCG64,default_rng) (#31). Each algorithm builds its own Generator fromrandom_seed; the parallel samplers (pt,am,dream,p_dream) additionally give every chain its ownSeedSequence.spawnsub-stream, so a seeded run now reproduces regardless of the order parallel results come back — the old shared global stream interleaved chain draws by completion order and so did not reproduce under real parallelism. Prior sampling, latin-hypercube initialization, and bootstrap-weight resampling now draw from the seeded Generator as well. Resuming a run restores the exact Generator state. Reproducibility note: because PCG64 is a different stream than MT19937,random_seed = Nproduces different (but still fully reproducible) results than prior releases — re-running with the same seed still reproduces saved data, including stochastic simulations understochastic_seed = auto(whose content-hashed sim seeds are unchanged). Saved reference data generated by older releases must be regenerated once.
- Removed the experimental S-CREAM (
s_cream) sampler and its user-facing configuration/docs.
- Simplex collinearity with
simplex_reflection=1andpopulation_size>1in low dimensions (#207) smoothingandparallelize_modelscan now be used together for multi-model stochastic jobs (#49)- Test failures in test_job_groups and test_seed_determinism caused by incorrect fixture paths (#361)
wall_time_simfor SBML models now works when PyBNF is installed via PyPI (#249)- Dependency warning spam (numpy, YAML, etc.) no longer clutters the terminal; routed to log file (#274)
- Invalid escape sequence
SyntaxWarnings in the test suite (regex literals such as'\s+'not marked raw); Python is escalating these towardSyntaxError
- New Bayesian sampler: DREAM(ZS) (
dreamfit type) with ZS archive, snooker updates, adaptive gamma, CR adaptation, R-hat convergence diagnostics, and outlier detection - New Bayesian sampler: Preconditioned DREAM (
p_dreamfit type) with covariance-preconditioned DE proposals - Effective Sample Size (ESS) computation and R-hat convergence diagnostics in BayesianAlgorithm base class
- Configurable convergence stopping criterion (
converge_criterion) and configurable delta for R-hat - RoadRunner
saveState/loadStateoptimization to avoid re-parsing XML on everyexecute()(closes #288) - Validation of
continue_runfiles before loading in Adaptive MCMC (#355) burn_invsmax_iterationsvalidation and guard against empty samples (#356)- Adaptive MCMC (
am) hardened for production use: input validation, robustness fixes - Warning when BNGL model has no observables defined (#298)
- Sampler benchmarking suite with analytical test targets
- Minimum libroadrunner version bumped from 1.5.2 to 1.6.0
- DREAM donor chain selection now uses all chains instead of subset
- DREAM acceptance ratio uses natural log instead of log10 (#353)
- Simplex refinement reuses generated networks (#112)
- Subprocess timeout now kills entire process group (#83)
- DREAM out-of-bounds proposals not recording chain state, causing silently empty results
- Normalization edge case affecting
.propconstraint columns with shared suffix (closes #276) - Unbounded parameters having implicit lower bound of 0 (#208)
- Crash on non-ASCII characters in model files (#189)
- Crash with floating-point step size in
time_coursefor XML models (#314) - Exception handler crash during network generation (#294)
KLLikelihood: negated return value and fixed broken data access (#352)_load_t_length: compute step count instead of storing step size (#354)- Skip variable correspondence check during model checking (#281)
np.Infreplaced withnp.inffor NumPy 2.0 compatibility (#349)
Versions 1.2.0–1.2.2 were untagged development versions (community-contributed examples, minor patches).
- Initial Adaptive MCMC algorithm implementation
- Negative binomial objective function
- Pinned
msgpack==0.6.2to fix compatibility issue
once betweenconstraint type for event-based constraints
pminandpmaxkeywords for setting parameter bounds in likelihood-based fitting- Logit likelihood as an alternative to static penalty for constraint evaluation
SplitAtConstraintclass for splitting data at constraint boundaries
- Data file duplicate column names now raise an error
- Unused data in
.expfiles now raises an error instead of a warning
- Simulated annealing crash when looking for
samples.txt - Errors from setting
population_sizetoo low
- Windows installation instructions and compatibility improvements
- First few failed simulation logs are now saved even without debug flag
- More descriptive error messages for BioNetGen configuration errors
- Absolute Windows paths starting with drive letter now recognized
os.renamereplaced withos.replacefor Windows compatibility- Crash when
dask-worker-spaceremoval fails
- Command line argument
--log-levelfor controlling logging verbosity - Cluster class consolidating all cluster setup code
- Renamed
bmcalgorithm tomh(Metropolis-Hastings);bmcstill accepted for backwards compatibility
- Missing final histogram output in MH/PT algorithms
- Renamed
.conconstraint file extension to.prop(property) - Updated license to Triad National Security, LLC
- Model checking mode for validating model configuration without running a fit
parallelize_modelskey for model-level parallelismsimulation_diroption to control simulation working directory- Sum of differences objective function
- Itemized constraint evaluation output
- Config file validation now checks for unrecognized keys
- Relative path bug for
failed_logs_diron clusters beta_rangecorrected and changed to geometric space- Badly-timed interrupt could lose algorithm backup
scheduler-fileargument for connecting to an existing Dask scheduler
- Dask client is now reused across multiple
Algorithm.run()calls
- Compatibility with newest Dask version
- Dockerfile for containerized execution
- Specific package version requirements in
setup.py
- Increased failed simulation tolerance to 100 before aborting
save_best_dataoption to rerun the best-fit simulation and save output data files
- RoadRunner output changed from "particles" to "concentration" mode to avoid unexpected results from SBML compartment volumes
- Bootstrapping with sum of squares objective
- Postprocessing
FailedSimulationresults no longer crashes
- LANL open-source license
parallel_countsupport fordask-sshcluster launches
- Random number overflow catch
- MCMC now prints accept rate to log
- PSO accepts first parameter set even if score is Inf
- Failed folder deletions no longer terminate the fitting run
- Custom postprocessing support via user-defined Python functions
- RoadRunner integrator configuration (Euler with subdivisions)
simulation_actionssupport for SBML models
- Parameters with
lower_bound == upper_boundare now allowed (fixed parameters)
- Bootstrap method for uncertainty quantification
- Thread leak: error catch and message when running out of threads
- Chi-squared formula corrected in documentation
- Default PSO inertia weight changed from 1.0 to 0.7
- Particle Swarm reflections corrected for log-space variables
- Recovery from "too many reflections" error instead of crash
Initial release of PyBNF. Core fitting engine with support for BioNetGen (BNGL)
and SBML models via libRoadRunner. Includes Particle Swarm Optimization, Differential
Evolution, Scatter Search, Metropolis-Hastings, Simulated Annealing, Parallel Tempering,
and Simplex algorithms. Distributed computing via Dask. Constraint evaluation,
data normalization, multi-model fitting, and .conf configuration file format.