Skip to content

NFC: Remove CBC from our installation documentation#1303

Merged
blnicho merged 1 commit intoPyomo:masterfrom
blnicho:doc-remove-cbc
Feb 24, 2020
Merged

NFC: Remove CBC from our installation documentation#1303
blnicho merged 1 commit intoPyomo:masterfrom
blnicho:doc-remove-cbc

Conversation

@blnicho
Copy link
Copy Markdown
Member

@blnicho blnicho commented Feb 19, 2020

Fixes #1302

Summary/Motivation:

This removes CBC from the list of solvers that we mention can be installed using conda in our installation documentation. @CatChenal pointed out that the conda package only works on Linux and OSX and @mrmundt pointed out that the newer version of CBC causes test failures (#1295). Rather than update the documentation with a bunch of caveats for a particular solver, I think the better approach is to remove it completely for now. We should probably add a section to the documentation that gives more guidance on installing different solvers but that is outside the scope of this PR.

Changes proposed in this PR:

  • Remove CBC from our conda installation documentation

Legal Acknowledgement

By contributing to this software project, I 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 a review from jsiirola February 19, 2020 22:43
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 19, 2020

Codecov Report

Merging #1303 into master will increase coverage by 0.76%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1303      +/-   ##
==========================================
+ Coverage   68.61%   69.38%   +0.76%     
==========================================
  Files         534      534              
  Lines       80977    81026      +49     
==========================================
+ Hits        55566    56216     +650     
+ Misses      25411    24810     -601     
Impacted Files Coverage Δ
pyomo/core/base/alias.py 0.00% <0.00%> (ø) ⬆️
pyomo/core/base/blockutil.py 0.00% <0.00%> (ø) ⬆️
pyomo/duality/lagrangian_dual.py 0.00% <0.00%> (ø) ⬆️
examples/pysp/scripting/solve_distributed.py 100.00% <0.00%> (ø) ⬆️
...trib/pynumero/algorithms/solvers/cyipopt_solver.py 0.00% <0.00%> (ø) ⬆️
pyomo/network/foqus_graph.py 90.61% <0.00%> (+0.23%) ⬆️
pyomo/contrib/pynumero/extensions/utils.py 70.37% <0.00%> (+3.70%) ⬆️
pyomo/contrib/pynumero/interfaces/nlp.py 45.86% <0.00%> (+45.86%) ⬆️
pyomo/contrib/pynumero/extensions/asl.py 86.04% <0.00%> (+65.69%) ⬆️
pyomo/contrib/pynumero/interfaces/ampl_nlp.py 93.20% <0.00%> (+93.20%) ⬆️
... and 2 more

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 bf7daa3...326456b. Read the comment docs.

@mrmundt
Copy link
Copy Markdown
Contributor

mrmundt commented Feb 20, 2020

Is this something we plan to add back eventually, or is the idea to remove it permanently?

@blnicho
Copy link
Copy Markdown
Member Author

blnicho commented Feb 20, 2020

My intention was to remove it permanently. It only appeared in the installation docs to provide a very brief note on a few solvers that were easy to install with Anaconda.

I think our users would certainly benefit from a more detailed/comprehensive guide on installing various solvers however this type of documentation would be time consuming to develop and difficult to keep up-to-date.

@blnicho blnicho merged commit 8558a54 into Pyomo:master Feb 24, 2020
@blnicho blnicho deleted the doc-remove-cbc branch February 24, 2020 14:50
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.

Platform dependence: Special case needed for coincbc in installation.rst

3 participants