max_stepsize attribute for festim.Stepsize

[KulaginVladimir]

Proposed changes

As discussed in #507, this PR introduces max_stepsize attribute for festim.Stepsize instead of t_stop and stepsize_stop_max. The old parameters are left unchanged, but a DeprecationWarning is added. With this change, the basic usage now becomes:

my_stepsize = F.Stepsize(
    initial_value=0.5,
    stepsize_change_ratio=1.1,
    max_stepsize=lambda t: None if t < 1 else 2,
    dt_min=1e-05,
)

Types of changes

What types of changes does your code introduce to FESTIM?

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Code refactoring
• Documentation Update (if none of the other choices apply)
• New tests

Checklist

• Black formatted
• Unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (49d18e8) 99.47% compared to head (cd9945d) 99.47%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #698   +/-   ##
=======================================
  Coverage   99.47%   99.47%           
=======================================
  Files          58       58           
  Lines        2280     2284    +4     
=======================================
+ Hits         2268     2272    +4     
  Misses         12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[RemDelaporteMathurin]

Hi @KulaginVladimir thanks for this!

I made a few comments + refactoring idea. Tell me what you think!

[RemDelaporteMathurin]

just a small comment for code readability

[RemDelaporteMathurin]

LGTM! Thanks @KulaginVladimir

As usual, I'll leave the PR open a little while longer to give everyone the chance to jump in