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

Adds max_step param to base_solver #4673

Open
wants to merge 18 commits into
base: develop
Choose a base branch
from

Conversation

medha-14
Copy link
Contributor

@medha-14 medha-14 commented Dec 13, 2024

Description

Fixes #2253

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@medha-14 medha-14 marked this pull request as draft December 13, 2024 12:43
@medha-14 medha-14 marked this pull request as ready for review December 14, 2024 07:34
@medha-14 medha-14 requested a review from rtimms as a code owner December 14, 2024 07:34
Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for starting this! The first part for renaming dt_max to dt_event is largely correct, and you've passed the argument to SciPy's solve_ivp correctly. However, from a first look for the JAX solver, I think this should be passed to jax.experimental.odeint(), noting the difference in the argument name (mxstep vs max_step). I'm much less familiar with the code for the CasadiSolver, so I'll let someone else comment on it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also add an entry to the breaking changes, concerning the rename of dt_max to dt_event.

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.

Max step size option
3 participants