-
Notifications
You must be signed in to change notification settings - Fork 109
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
Installation docs update #350
Conversation
Codecov Report
@@ Coverage Diff @@
## main #350 +/- ##
===========================================
- Coverage 84.42% 72.51% -11.92%
===========================================
Files 22 22
Lines 3307 3307
===========================================
- Hits 2792 2398 -394
- Misses 515 909 +394 see 7 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Nice!, just a quick question, is IPOPT an open-source? if So, we can point out that. |
Yes, IPOPT is open source and that is already mentioned in https://mdolab-pyoptsparse.readthedocs-hosted.com/en/latest/optimizers/IPOPT.html . So I think we don't have to say that on the installation page? |
Yes, forgot it is mentioned there. For consistency, we can point out the IPOPT installation page similar to how you are pointing out the SNOPT installation page. |
@ArshSaja added the link to the IPOPT page. @marcomangano I think the line you added about the SNOPT precompiled library better fits under the |
Thanks, looks good! |
Yeah fair, the details are in the SNOPT page anyway! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Builds should be reported properly now. Unrelated, but we really should do something about codecov...
Purpose
This PR adds installation instructions using OpenMDAO's
build_pyoptsparse
script on the installation documentation page.This script has already been mentioned on the IPOPT page, but I think it's worth putting this on the installation page for more attention. (This script is probably the easiest way to install IPOPT and SNOPT, especially on macOS, but I recently realized that some people are not aware of it.)
Expected time until merged
a week
Type of change
Testing
Checklist
flake8
andblack
to make sure the Python code adheres to PEP-8 and is consistently formattedfprettify
or C/C++ code withclang-format
as applicable