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

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

Open
moorepants opened this issue May 20, 2022 · 3 comments
Open

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

moorepants opened this issue May 20, 2022 · 3 comments

Comments

@moorepants
Copy link

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:

Reads the options list and assigns values for the solver.

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

@paulhprobert
Copy link

paulhprobert commented May 26, 2022

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
Copy link

You can also get the set_options documentation like this:
>>>import scikits.odes.sundials.ida as ida
>>>help(ida.IDA.set_options)

@moorepants
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants