Skip to content

Commit

Permalink
pybamm.JaxSolver docstring improvement (#3994)
Browse files Browse the repository at this point in the history
* pybamm.JaxSolver docstring improvement

* Update conf.py to add `intersphinx_mapping` for `jax`

* Update jax_solver.py to fix docstring rendering

* Update docs/conf.py

Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>

* Update pybamm/solvers/jax_solver.py

* Update docs/conf.py

* Apply suggestions from code review

* Update pybamm/solvers/jax_solver.py

Co-authored-by: Arjun Verma <arjunverma.oc@gmail.com>

* Update pybamm/solvers/jax_solver.py

Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>

* Update docs/conf.py

Co-authored-by: Eric G. Kratz <kratman@users.noreply.github.com>

---------

Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
Co-authored-by: Arjun Verma <arjunverma.oc@gmail.com>
Co-authored-by: Eric G. Kratz <kratman@users.noreply.github.com>
  • Loading branch information
4 people committed May 31, 2024
1 parent ce1d87a commit 16da4ca
Showing 1 changed file with 3 additions and 3 deletions.
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 `jax.experimental.ode.odeint` for details)
* 'RK45' (default) uses jax.experimental.ode.odeint
* 'BDF' uses custom jax_bdf_integrate (see `jax_bdf_integrate.py` for details)
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

0 comments on commit 16da4ca

Please sign in to comment.