-
Notifications
You must be signed in to change notification settings - Fork 562
Pyomo.Doe: update documentation #3812
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…sted by running it.
|
@smondal13 - We have standardized to "Parmest" or "parmest", not "ParmEst". It's the source of the typo checker yelling at you. |
|
Thank you @mrmundt |
|
@adowling2 @blnicho This PR is ready for review Note: Merge PR #3803 before this one. The documentation in this PR contains updated information from that PR |
| :end-before: End sensitivity analysis | ||
|
|
||
| An example output of the code above, a design exploration for the initial concentration and temperature as experimental design variables with 9 values, produces the four figures summarized below: | ||
| .. code-block:: python |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are you embedding the example instead of using .. literalinclude::? As implemented, this example is no longer being tested (which is a problem).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I copied and pasted the code from the example to skip the booleans that we have in the original example. However, I agree that testing this is important. So, I have added .. literalinclude:: and removed the copy-pasted code.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3812 +/- ##
==========================================
- Coverage 89.41% 89.41% -0.01%
==========================================
Files 909 909
Lines 105579 105579
==========================================
- Hits 94408 94407 -1
- Misses 11171 11172 +1
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:
Pyomo.DoE documentation was old and needed an update.
Changes proposed in this PR:
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: