Skip to content

Conversation

@blnicho
Copy link
Member

@blnicho blnicho commented Jan 18, 2022

Fixes #2258

Summary/Motivation:

This fixes a typo in the installation documentation and adds a sentence describing how to install all optional dependencies using pip. I also alphabetized the list of conditional dependencies. Once this PR is approved I'll update the identical text on the Pyomo website.

Changes proposed in this PR:

  • updating installation documentation

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@blnicho blnicho requested review from jsiirola and mrmundt January 18, 2022 19:19
Copy link
Contributor

@mrmundt mrmundt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No spelling errors! You may want to add that you can also install it using:

python setup.py dependencies --extra optional

@codecov
Copy link

codecov bot commented Jan 18, 2022

Codecov Report

Merging #2259 (1708440) into main (e0b5873) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2259   +/-   ##
=======================================
  Coverage   84.21%   84.22%           
=======================================
  Files         607      607           
  Lines       76191    76191           
=======================================
+ Hits        64167    64169    +2     
+ Misses      12024    12022    -2     
Flag Coverage Δ
linux 81.99% <ø> (+<0.01%) ⬆️
osx 72.42% <ø> (ø)
other 81.94% <ø> (ø)
win 79.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pyomo/solvers/plugins/solvers/ASL.py 90.00% <0.00%> (-1.43%) ⬇️
pyomo/contrib/mindtpy/iterate.py 79.47% <0.00%> (+1.74%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e0b5873...1708440. Read the comment docs.

@blnicho
Copy link
Member Author

blnicho commented Jan 20, 2022

No spelling errors! You may want to add that you can also install it using:

python setup.py dependencies --extra optional

Done

@jsiirola jsiirola merged commit 7b76b1d into Pyomo:main Jan 22, 2022
@blnicho blnicho deleted the update-install-docs branch January 24, 2022 18:01
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.

Website: installation depencencies list.

3 participants