hgrecco / numbakit-ode

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

Issues in Tutorial Documentation #9

Closed DhruvSondhi closed 3 years ago

DhruvSondhi commented 3 years ago

Hello, I was trying to run some tutorial examples in a jupyter notebook but faced numerous issues while running the examples... I have seen there are small issues in the documentation for the same on https://numbakit-ode.readthedocs.io/en/latest/tutorial.html#solving-a-simple-equation ... I have solved them from my side while running the examples ... I would be very happy to fix the documentation for the same if it is possible as it may become problem for more people experimenting with the library ... Cheers :)

hgrecco commented 3 years ago

The API evolved since the first version. We will be releasing 0.4 in the upcoming days, maybe is better to fix the docs after that. Please check back in a week or so.

DhruvSondhi commented 3 years ago

Sure thing sir ... Do let me know whenever it may be possible to fix the docs ... thanks for the reply :)

hgrecco commented 3 years ago

The tests are fixed. Maybe you can update the docs to the current master so we can create 0.4 with the updated docs. Sounds good to you?

DhruvSondhi commented 3 years ago

Yes sure thing sir ... I will start it as soon as possible & create a PR for the same :+1:

DhruvSondhi commented 3 years ago

Sir I have created a PR on the same ===> #10 .... Do let me know if anything else can be done ... Would be happy to contribute :+1: