search

bmcage / odes

The ODES scikit for ordinary differential and algebraic equations, an extension to scipy
https://scikits-odes.readthedocs.io/
Other
122 stars 44 forks source link

Difficult to find the dae() options in the online documentation #135

Open moorepants opened 2 years ago

moorepants commented 2 years ago

I've been trying out the dae() solver and I was not able to find explanations of the possible kwargs for the function in the online documentation. I did find this in the code:

https://github.com/bmcage/odes/blob/1e3b3324748f4665ee5a52ed1a6e0b7e6c05be7d/scikits/odes/sundials/ida.pyx#L848

but I'm not finding it exposed in the online documentation. It would be helpful if it was exposed there.

paulhprobert commented 2 years ago

I've found that the text in ida.pyx below the line 848 that you show is the best place to read about the options to the ida solver. But there are also some ipython notebooks in scikits/odes/docs/ipython which have a lot of text .

paulhprobert commented 2 years ago

You can also get the set_options documentation like this:

import scikits.odes.sundials.ida as ida help(ida.IDA.set_options)

moorepants commented 2 years ago

Thanks, I've figured those things out hunting around, but my suggestion would be to expose this in the sphinx docs. I'm using this package in my graduate course and the students are new to Python, so the most obvious place for them to look for details like this is the online documentation (which I can also reference in my online notes with sphinx's intersphinx capability). I don't think my students would easily find these settings, as it took careful searching to locate it myself.