You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Based on our benchmark paper, we now automatically select a gradient method, Hessian method, and ODE solver based on the problem (e.g. number of model parameters) if the user does not provide any options. Thus if a PEtabODEProblem is created via
petabProblem =createPEtabODEProblem(petabModel),
a PEtabODEProblem with options that are likely to perform well specific model is created.
Additional features for PEtabODEProblem
Via the PEtabODEProblem we can now in addition to previously supported methods compute:
Non-inplace gradient via gradient = petabProblem.computeGradient(θ)
Non-inplace Hessian via hessian = petabProblem.computeHessian(θ)
Chi2 value via chi2 = petabProblem.computeChi2(θ)
Simulated values (h-model which are matched against experimental data) via simulatedValues = petabProblem.computeSimulatedValues(θ)
Residuals, (h_model - h_observed)^2 / σ^2, for each time-point via residuals = petabProblem.computeHessian(θ)
Note that both the residuals and simulated values are computed in the same order the data points occur in the PEtab-measurement table.
Defining the Model Directly in Julia Instead of via SBML
By the PEtab standard, the ODE model should be defined in the SBML format. However, sometimes it can be easier to write the model directly in Julia. Thus, we have added support for directly defining the model in the ModelingToolkit.jl format. Guidelines on how to formulate the model can be found in the documentation under Providing the model as a Julia file instead of a SBML File.
Breaking Changes
The following functions have been replaced/renamed:
setupPEtabODEProblem has been replaced with createPEtabODEProblem. Unlike setupPEtabODEProblem, createPEtabODEProblem only takes one required argument (the petab-model). Any other options are provided via keywords, so to set an ODE solver, for example, provide the following:
getODESolverOptions has been replaced by directly calling a constructor method for ODESolverOptions. To create an ODESolverOptions struct, simply call:
getSteadyStateSolverOptions has been replaced by directly calling a constructor method for SteadyStateSolverOptions. To create a SteadyStateSolverOptions struct, simply call:
Since this package is young, breaking changes like these occur. However, we aspire to keep breaking changes to a minimum, and we appreciate users patience.
Other Changes
Improved the readability of the documentation.
We now test against the PEtab test suite. We are happy to report that after some small adjustments, our package now passes all tests and fully supports PEtab.
We removed DataFrames as a dependency to reduce load times.
Extented SBML support to handle boundary conditions.
9988c2bThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JuliaRegistrator register
Release notes:
New Features
Creating PEtabODEProblem with default options
Based on our benchmark paper, we now automatically select a gradient method, Hessian method, and ODE solver based on the problem (e.g. number of model parameters) if the user does not provide any options. Thus if a
PEtabODEProblemis created viaa
PEtabODEProblemwith options that are likely to perform well specific model is created.Additional features for PEtabODEProblem
Via the
PEtabODEProblemwe can now in addition to previously supported methods compute:gradient = petabProblem.computeGradient(θ)hessian = petabProblem.computeHessian(θ)chi2 = petabProblem.computeChi2(θ)simulatedValues = petabProblem.computeSimulatedValues(θ)residuals = petabProblem.computeHessian(θ)Defining the Model Directly in Julia Instead of via SBML
By the PEtab standard, the ODE model should be defined in the SBML format. However, sometimes it can be easier to write the model directly in Julia. Thus, we have added support for directly defining the model in the
ModelingToolkit.jlformat. Guidelines on how to formulate the model can be found in the documentation under Providing the model as a Julia file instead of a SBML File.Breaking Changes
The following functions have been replaced/renamed:
setupPEtabODEProblemhas been replaced withcreatePEtabODEProblem. UnlikesetupPEtabODEProblem,createPEtabODEProblemonly takes one required argument (the petab-model). Any other options are provided via keywords, so to set an ODE solver, for example, provide the following:getODESolverOptionshas been replaced by directly calling a constructor method forODESolverOptions. To create anODESolverOptionsstruct, simply call:getSteadyStateSolverOptionshas been replaced by directly calling a constructor method forSteadyStateSolverOptions. To create aSteadyStateSolverOptionsstruct, simply call:Since this package is young, breaking changes like these occur. However, we aspire to keep breaking changes to a minimum, and we appreciate users patience.
Other Changes
9988c2bThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Registration pull request updated: JuliaRegistries/General/83301
After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.
This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via: