New Installation Guide#773
Merged
jkirk5 merged 23 commits intoOpenMDAO:mainfrom May 29, 2025
Merged
Conversation
ehariton
reviewed
May 21, 2025
ehariton
reviewed
May 21, 2025
| $ git clone git@github.com:OpenMDAO/OpenMDAO.git | ||
| ``` | ||
| #### Adding SNOPT | ||
| [SNOPT](http://ccom.ucsd.edu/~optimizers/solvers/snopt/) is a proprietary, high-performance optimizer that is very good at solving large nonlinear problems and is used by many OpenMDAO users. SNOPT is only supported on Linux. |
Member
There was a problem hiding this comment.
Technically supported on macos unix as well.
Contributor
Author
There was a problem hiding this comment.
I can acknowledge that and WSL too
| $ git clone git@github.com:OpenMDAO/dymos.git | ||
| $ cd dymos | ||
| $ pip install -e . | ||
| subprocess.CalledProcessError: Command '['mamba', 'info', '--unsafe-channels']' returned non-zero exit status 109. |
Member
There was a problem hiding this comment.
We should try to collect our common installation errors (in all of our upcoming refreshes) to add to this database.
scaling back a test
Kenneth-T-Moore
approved these changes
May 28, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrote the installation guide to be as simple and flexible as possible with three installation types.
Tweaked optional-dependencies tags in pyproject based on experience with fresh minimal installations on Windows & Linux. Many old optional dependencies were themselves dependencies of other packages we need, so they were redundant. New tags better align with installation guide. New tags include:
[dev]: everything needed to run a successful testflo (assuming pyoptsparse is manually installed), plus pre-commit[docs]: everything needed to successfully build the docs without error (also assumes pyoptsparse manually installed)[all]: everything in[dev]and[docs]Renamed some of the examples to be shorter and more clear what they actually are, and to help users better understand the interface levels intuitively, by picking the example with that level in the file name.