Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change default steady-state method to integrationOnly #2574

Merged
merged 1 commit into from
Nov 10, 2024

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Nov 8, 2024

Breaking change

Change the default mode for computing steady states and sensitivities at steady state to integrationOnly (from previously integrateIfNewtonFails).

This is done for a more robust default behaviour. For example, the evaluation in https://doi.org/10.1371/journal.pone.0312148 shows that - at least for some models - Newton's method may easily lead to physically impossible solutions.

To keep the previous behaviour, use:

amici_model.setSteadyStateComputationMode(amici.SteadyStateComputationMode.integrateIfNewtonFails)
amici_model.setSteadyStateSensitivityMode(amici.SteadyStateSensitivityMode.integrateIfNewtonFails)

Closes #2571.

Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.75%. Comparing base (0009c4a) to head (e47ef3c).
Report is 3 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2574      +/-   ##
===========================================
- Coverage    77.76%   77.75%   -0.01%     
===========================================
  Files          325      325              
  Lines        21861    21861              
  Branches      1473     1473              
===========================================
- Hits         17000    16999       -1     
- Misses        4834     4835       +1     
  Partials        27       27              
Flag Coverage Δ
cpp 73.63% <ø> (-0.01%) ⬇️
cpp_python 34.20% <ø> (-0.01%) ⬇️
petab 37.08% <ø> (-0.01%) ⬇️
python 72.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
include/amici/model.h 76.19% <ø> (ø)

... and 1 file with indirect coverage changes

@dweindl dweindl marked this pull request as ready for review November 9, 2024 09:28
@dweindl dweindl requested a review from a team as a code owner November 9, 2024 09:28
@dweindl dweindl self-assigned this Nov 9, 2024
**Breaking change**

Change the default mode for computing steady states and sensitivities
at steady state to `integrationOnly` (from previously `integrateIfNewtonFails`).

This is done for a more robust default behaviour. For example, the
evaluation in https://doi.org/10.1371/journal.pone.0312148 shows
that - at least for some models - Newton's method may easily lead to
physically impossible solutions.

To keep the previous behaviour, use:
```python
amici_model.setSteadyStateComputationMode(amici.SteadyStateComputationMode.integrateIfNewtonFails)
amici_model.setSteadyStateSensitivityMode(amici.SteadyStateSensitivityMode.integrateIfNewtonFails)
```

Closes AMICI-dev#2571.
@dweindl dweindl force-pushed the gh2571_default_ssmode branch from 4888cfd to e47ef3c Compare November 10, 2024 08:57
@dweindl dweindl enabled auto-merge November 10, 2024 08:57
@dweindl dweindl added this pull request to the merge queue Nov 10, 2024
Merged via the queue into AMICI-dev:develop with commit a1cdcb8 Nov 10, 2024
19 of 20 checks passed
@dweindl dweindl deleted the gh2571_default_ssmode branch November 10, 2024 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants