Solution Pool

[whart222]

Fixes N/A (partially addresses #3513) .

Summary/Motivation:

The alternative_solutions contrib package includes a rudimentary solution pool object. This PR includes a more comprehensive capability for defining and managing solution pools.

Changes proposed in this PR:

• PyomoPoolManager - Manages pools for Pyomo solutions
• SolutionPool* - Classes used to define various solution pools
• Functions in pyomo.contrib.alternative_solutions now use and return PyomoPoolManager instances.
• PyomoSolution - Function that returns a Solution object given Pyomo model data

NOTE: This is a WIP PR. I'm submitting this now to help define expectations for finalizing this new capability.

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.

[whart222]

Note that this PR now includes updates to the Bunch class defined in pyomo.common. I have been using the public Munch class, but these revisions align the Bunch API with Munch.

[codecov]

Codecov Report

❌ Patch coverage is 88.54962% with 60 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.32%. Comparing base (13facca) to head (f2ad6c0).
⚠️ Report is 89 commits behind head on main.

Files with missing lines	Patch %	Lines
pyomo/contrib/alternative_solutions/solnpool.py	90.87%	25 Missing ⚠️
...mo/contrib/alternative_solutions/gurobi_lp_enum.py	13.33%	13 Missing ⚠️
pyomo/contrib/alternative_solutions/solution.py	92.52%	8 Missing ⚠️
pyomo/contrib/alternative_solutions/balas.py	76.47%	4 Missing ⚠️
...o/contrib/alternative_solutions/gurobi_solnpool.py	90.90%	4 Missing ⚠️
pyomo/contrib/alternative_solutions/aos_utils.py	85.00%	3 Missing ⚠️
pyomo/contrib/alternative_solutions/lp_enum.py	78.57%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3657      +/-   ##
==========================================
- Coverage   89.40%   89.32%   -0.09%     
==========================================
  Files         909      910       +1     
  Lines      105541   105935     +394     
==========================================
+ Hits        94364    94631     +267     
- Misses      11177    11304     +127     

Flag	Coverage Δ
builders	29.11% <30.91%> (+<0.01%)	⬆️
default	85.96% <87.40%> (?)
expensive	35.75% <30.91%> (?)
linux	86.65% <88.54%> (-2.53%)	⬇️
linux_other	86.65% <88.54%> (-0.08%)	⬇️
osx	82.81% <88.54%> (-0.06%)	⬇️
win	84.91% <88.54%> (-0.07%)	⬇️
win_other	84.91% <88.54%> (-0.07%)	⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[whart222]

It's not obvious to me why the linux slim tests are failing. Do we need to conditionally import numpy?

[blnicho]

It's not obvious to me why the linux slim tests are failing. Do we need to conditionally import numpy?

@whart222 yes, numpy needs to be treated as an optional dependency so tests relying on numpy need to be skipped when it's not available.

[mrmundt]

@whart222 - Should this PR be closed, given the followup to our discussion last month?