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

Installation docs update #350

Merged
merged 7 commits into from
Jun 30, 2023
Merged

Installation docs update #350

merged 7 commits into from
Jun 30, 2023

Conversation

kanekosh
Copy link
Contributor

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

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run flake8 and black to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@kanekosh kanekosh requested a review from a team as a code owner June 28, 2023 22:34
@codecov
Copy link

codecov bot commented Jun 28, 2023

Codecov Report

Merging #350 (67a164f) into main (fe2a819) will decrease coverage by 11.92%.
The diff coverage is n/a.

@@             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

@ArshSaja
Copy link
Contributor

Nice!, just a quick question, is IPOPT an open-source? if So, we can point out that.

@kanekosh
Copy link
Contributor Author

kanekosh commented Jun 29, 2023

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?

@ArshSaja
Copy link
Contributor

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.

@kanekosh
Copy link
Contributor Author

@ArshSaja added the link to the IPOPT page.

@marcomangano I think the line you added about the SNOPT precompiled library better fits under the conda section, so I moved it. Does this look good to you?

@ArshSaja
Copy link
Contributor

@ArshSaja added the link to the IPOPT page.

@marcomangano I think the line you added about the SNOPT precompiled library better fits under the conda section, so I moved it. Does this look good to you?

Thanks, looks good!

@marcomangano
Copy link
Contributor

@marcomangano I think the line you added about the SNOPT precompiled library better fits under the conda section, so I moved it. Does this look good to you?

Yeah fair, the details are in the SNOPT page anyway!

@marcomangano
Copy link
Contributor

Tests are passing but somehow the info is not passed back from Azure. For now, can @eirikurj or @anilyil override the test requirements and merge this? Thx

Copy link
Contributor

@eirikurj eirikurj left a 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...

@eirikurj eirikurj merged commit 7e01f2c into mdolab:main Jun 30, 2023
@kanekosh kanekosh deleted the docs_update branch July 10, 2023 20:23
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

Successfully merging this pull request may close these issues.

4 participants