Reorganizing ParmEst and Pyomo.DoE Documentation Pages#3904
Reorganizing ParmEst and Pyomo.DoE Documentation Pages#3904slilonfe5 wants to merge 5 commits intoPyomo:mainfrom
Conversation
|
@mrmundt @blnicho @jsiirola @adowling2, This PR is ready for review. As mentioned in the description, we want to reorganize the documentation webpages of ParmEst and Pyomo.DoE into a structure that is informative, capturing the most up-to-date capabilities, ahead of the ACC Pyomo workshop in May. This PR is meant to create background documentation files and structures for @sscini and @smondal13 to quickly update after their PRs get merged. A major question is whether we should remove the other existing ParmEst documentation pages (e.g., data reconciliation, scenario creation). Thank you. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3904 +/- ##
==========================================
- Coverage 89.93% 89.93% -0.01%
==========================================
Files 902 902
Lines 106393 106393
==========================================
- Hits 95683 95680 -3
- Misses 10710 10713 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Fixes # .
Summary/Motivation:
The ParmEst and Pyomo.DoE documentation webpages need a major reorganization ahead of the American Control Conference Workshop in May. This update will enable new/existing users to access recent/forthcoming capabilities in ParmEst and Pyomo.DoE
Changes proposed in this PR:
Proposed ParmEst documentation page:
- Overview
- Installation Instructions
- Quick Start Guide
- Objective Options
- Uncertainty Quantification
- Estimability Analysis
Proposed Pyomo.DoE documentation page:
- Overview
- Quick Start Guide
- Experiment Abstraction
- Objective Options
- Multiple Experiments
- Parameter Uncertainty
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: