Aviary icon indicating copy to clipboard operation
Aviary copied to clipboard

Examples and documentation should always work with "base" Aviary install

Open jkirk5 opened this issue 8 months ago • 1 comments

Desired documentation content.

We should confirm that all examples and places the documentation gives example code or commands that users are expected to try out for themselves work with a basic Aviary install (pip install with no optional packages). A main place this causes issues is where IPOPT is used. Examples should check if this is an option and default to SLSQP, and documentation should either use SLSQP and state in text that IPOPT can be used if installed (or the reverse, where we default to IPOPT but explain to use SLSQP if you don't have pyoptsparse)

Is there any existing documentation on your requested topic? Please describe.

No response

jkirk5 avatar Apr 21 '25 14:04 jkirk5

We could have some boilerplate code or a function call that automatically selects the "best" optimizer available on the system to use. run_OAS_wing_mass_example.py has an example of this. Abstracting it into a function would probably be easier to understand for novice users who can just ignore that one line.

jkirk5 avatar Aug 25 '25 18:08 jkirk5