Skip to content

Updates to ParmEst documentation#3791

Merged
mrmundt merged 32 commits intoPyomo:mainfrom
slilonfe5:parmest-doc-update
Jan 23, 2026
Merged

Updates to ParmEst documentation#3791
mrmundt merged 32 commits intoPyomo:mainfrom
slilonfe5:parmest-doc-update

Conversation

@slilonfe5
Copy link
Copy Markdown
Member

@slilonfe5 slilonfe5 commented Nov 25, 2025

Summary/Motivation:

The current documentation of ParmEst does not provide a detailed and step-by-step guide on using ParmEst to perform model-building tasks such as parameter estimation and covariance matrix calculation.

Changes proposed in this PR:

  • Add a step-by-step guide on how to create the Experiment class and its list using the simple Rooney-Biegler paper example
  • Link the parameter estimation page to the covariance matrix estimation page to refer users to creating the Experiment class and its list.

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.

@codecov
Copy link
Copy Markdown

codecov bot commented Nov 30, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.44%. Comparing base (e0fcc81) to head (0db821b).
⚠️ Report is 33 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #3791      +/-   ##
==========================================
- Coverage   89.45%   89.44%   -0.01%     
==========================================
  Files         905      905              
  Lines      105467   105467              
==========================================
- Hits        94341    94338       -3     
- Misses      11126    11129       +3
Flag Coverage Δ
builders 29.15% <ø> (+<0.01%) ⬆️
default 86.07% <ø> (?)
expensive 35.77% <ø> (?)
linux 86.77% <ø> (-2.45%) ⬇️
linux_other 86.77% <ø> (ø)
osx 82.92% <ø> (ø)
win 84.99% <ø> (-0.01%) ⬇️
win_other 84.99% <ø> (-0.01%) ⬇️

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.

@blnicho blnicho moved this from Todo to Development in ParmEst & Pyomo.DoE Development Dec 9, 2025
@slilonfe5 slilonfe5 marked this pull request as ready for review December 12, 2025 13:56
@blnicho blnicho moved this from Development to Ready for final review in ParmEst & Pyomo.DoE Development Dec 12, 2025
@slilonfe5
Copy link
Copy Markdown
Member Author

slilonfe5 commented Dec 16, 2025

@blnicho @mrmundt @jsiirola @adowling2 This PR on updates to the ParmEst documentation is ready for final review. Two tests are failing on the installation of Python packages and extensions.

@blnicho blnicho self-requested a review December 16, 2025 19:52
blnicho
blnicho reviewed Jan 15, 2026
View reviewed changes
slilonfe5 and others added 10 commits January 15, 2026 16:44
@slilonfe5 @blnicho
Update doc/OnlineDocs/explanation/analysis/parmest/driver.rst
beebef4 
Co-authored-by: Bethany Nicholson <[email protected]>
@slilonfe5 @blnicho
Update doc/OnlineDocs/explanation/analysis/parmest/driver.rst
94db2cb 
Co-authored-by: Bethany Nicholson <[email protected]>
@slilonfe5 @blnicho
Update doc/OnlineDocs/explanation/analysis/parmest/driver.rst
89f8196 
Co-authored-by: Bethany Nicholson <[email protected]>
@slilonfe5 @blnicho
Update doc/OnlineDocs/explanation/analysis/parmest/driver.rst
857f49c 
Co-authored-by: Bethany Nicholson <[email protected]>
@slilonfe5
Implemented Bethany's feedback
9d1cb97
@slilonfe5
Merge branch 'parmest-doc-update' of https://github.com/slilonfe5/pyomo…
83c4ec6 
… into parmest-doc-update
@slilonfe5
Updated driver.rst and installation.rst files
5d80a91
@slilonfe5
Updated driver.rst
f2166a5
@slilonfe5
Updated driver.rst file
ccae8b9
@slilonfe5
Updated driver.rst file
ee41175
@slilonfe5
Copy link
Copy Markdown
Member Author

slilonfe5 commented Jan 16, 2026

@blnicho I have implemented all the feedback. There are two tests failing on download and installation of extensions. Thanks

@blnicho blnicho moved this from Todo to Review In Progress in Pyomo 6.10 Jan 21, 2026
@blnicho
Merge branch 'main' into parmest-doc-update
81b29c8
@blnicho
Revise Parmest Quick Start Guide content
28bee60 
Updated the Parmest Quick Start Guide to clarify the usage of the Experiment class and objective functions for parameter estimation.
@blnicho
Copy link
Copy Markdown
Member

blnicho commented Jan 22, 2026

@slilonfe5 I went ahead and made some significant edits in driver.rst to make the text more concise. Once the docs are done building I will verify that everything looks right and approve this PR.

@slilonfe5
Copy link
Copy Markdown
Member Author

slilonfe5 commented Jan 22, 2026

@slilonfe5 I went ahead and made some significant edits in driver.rst to make the text more concise. Once the docs are done building I will verify that everything looks right and approve this PR.

@blnicho sounds great. Thank you

@github-project-automation github-project-automation bot moved this from Review In Progress to Reviewer Approved in Pyomo 6.10 Jan 22, 2026
@mrmundt mrmundt merged commit 4d67fa6 into Pyomo:main Jan 23, 2026
35 checks passed
@github-project-automation github-project-automation bot moved this from Ready for final review to Done in ParmEst & Pyomo.DoE Development Jan 23, 2026
@github-project-automation github-project-automation bot moved this from Reviewer Approved to Done in Pyomo 6.10 Jan 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@blnicho blnicho blnicho approved these changes

@mrmundt mrmundt mrmundt approved these changes

Assignees

No one assigned

Labels

ParmEst

Projects

ParmEst & Pyomo.DoE Development
Status: Done
Pyomo 6.10
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@slilonfe5 @blnicho @mrmundt @jsiirola @pyomo-autotest @sscini