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

pybamm.JaxSolver docstring improvement #3994

Merged
merged 17 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@
"numpy": ("https://numpy.org/doc/stable", None),
"scipy": ("https://docs.scipy.org/doc/scipy", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"jax": ("https://jax.readthedocs.io/en/stable", None),
arjxn-py marked this conversation as resolved.
Show resolved Hide resolved
}

# -- sphinxcontrib-bibtex configuration --------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions pybamm/solvers/jax_solver.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ class JaxSolver(pybamm.BaseSolver):

Parameters
----------
method: str
'RK45' (default) uses jax.experimental.odeint
'BDF' uses custom jax_bdf_integrate (see jax_bdf_integrate.py for details)
method: str, optional (see :func:`jax.experimental.odeint` for details)
arjxn-py marked this conversation as resolved.
Show resolved Hide resolved
* 'RK45' (default) uses jax.experimental.odeint
arjxn-py marked this conversation as resolved.
Show resolved Hide resolved
* 'BDF' uses custom jax_bdf_integrate (see :func:`jax_bdf_integrate.py` for details)
kratman marked this conversation as resolved.
Show resolved Hide resolved
root_method: str, optional
Method to use to calculate consistent initial conditions. By default this uses
the newton chord method internal to the jax bdf solver, otherwise choose from
Expand Down
Loading