search

hgrecco / numbakit-ode

Leveraging numba to speed up ODE integration
Other
68 stars 3 forks source link

Documentation fixes #20

Open Yash-10 opened 3 years ago

Yash-10 commented 3 years ago

This pull request explicitly redirects to main rather than master for links on README, since the default branch was updated to main.

Additionally, I found that running:

nbkode.get_solvers('euler', 'adam-bashforth')

from the latest docs gives a key error. It seems that there was a missing s in adam-bashforth.

Question Since the output after running:

>>> nbkode.get_groups()
('Adams-Bashforth', 'Adams-Moulton', 'BDF', 'Euler', 'Runge-Kutta')

is the above, would it be a good choice to change as per the below:

- nbkode.get_solvers('euler', 'adam-bashforth')
+ nbkode.get_solvers('Euler', 'Adams-Bashforth')

The latest commit tries to include link to the documentation as per #21 .

Thanks!

Yash-10 commented 3 years ago

@hgrecco Could you take a look at this?

Thanks!