PR 7/7: Pyomo documentation, examples, and CHANGELOG#12
Open
bernalde wants to merge 1 commit intopr/benchmarksfrom
Open
PR 7/7: Pyomo documentation, examples, and CHANGELOG#12bernalde wants to merge 1 commit intopr/benchmarksfrom
bernalde wants to merge 1 commit intopr/benchmarksfrom
Conversation
22201d0 to
ba7dde7
Compare
ba7dde7 to
1fe10d0
Compare
3e5b8e4 to
76a65e5
Compare
1fe10d0 to
4cac1fd
Compare
This PR adds user-facing documentation and examples for Pyomo integration: Documentation: - lyopronto/pyomo_models/README.md: Detailed module documentation - CHANGELOG.md: Version history documenting all changes - CONTRIBUTING.md: Updated contribution guidelines - docs/PR_IMPLEMENTATION_PLAN.md: PR strategy documentation Examples: - examples/example_pyomo_optimizer.py: Working example of Pyomo optimization - Shows usage of optimize_Tsh_pyomo, optimize_Pch_pyomo, optimize_Pch_Tsh_pyomo - Comparison with scipy results - Performance benchmarking Quick start for users: # Install with Pyomo support pip install .[optimization] # Run example python examples/example_pyomo_optimizer.py This completes the Pyomo integration for LyoPRONTO. Users can now choose between scipy (default) and Pyomo optimization backends.
4cac1fd to
c0ef239
Compare
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
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
User-facing documentation for the Pyomo integration. CHANGELOG covers all Pyomo additions. Example script demonstrates Pyomo optimizer usage with comparison to scipy. Module README explains architecture, usage patterns, and troubleshooting. Contributing guide updated for Pyomo development workflow.
PR 7 of 7 in the Pyomo integration series. This is the final PR — merging this completes the Pyomo integration.
Changes
CHANGELOG.md— Version history with Pyomo additionsCONTRIBUTING.md— Updated contribution guidelines for Pyomo developmentdocs/PR_IMPLEMENTATION_PLAN.md— Implementation plan documentationexamples/example_pyomo_optimizer.py— Example script demonstrating Pyomo usagelyopronto/pyomo_models/README.md— Pyomo module documentation (architecture, usage, troubleshooting)PR Chain (Complete)
Testing
No new tests — documentation and examples only.