Skip to content

PR 7/7: Pyomo documentation, examples, and CHANGELOG#12

Open
bernalde wants to merge 1 commit intopr/benchmarksfrom
pr/docs-examples
Open

PR 7/7: Pyomo documentation, examples, and CHANGELOG#12
bernalde wants to merge 1 commit intopr/benchmarksfrom
pr/docs-examples

Conversation

@bernalde
Copy link
Member

@bernalde bernalde commented Mar 3, 2026

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 additions
  • CONTRIBUTING.md — Updated contribution guidelines for Pyomo development
  • docs/PR_IMPLEMENTATION_PLAN.md — Implementation plan documentation
  • examples/example_pyomo_optimizer.py — Example script demonstrating Pyomo usage
  • lyopronto/pyomo_models/README.md — Pyomo module documentation (architecture, usage, troubleshooting)

PR Chain (Complete)

# PR Status
0 Sync upstream (#5) Merged
1 CI/CD for Pyomo (#6) Open
2 Pyomo dependencies (#7) Open
3 Utils & single-step (#8) Open
4 Multi-period model (#9) Open
5 Optimizer functions (#10) Open
6 Benchmarks (#11) Open
7 Docs & examples (this PR)

Testing

No new tests — documentation and examples only.

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.
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.

1 participant