Skip to content

Commit 40faff7

Browse files
committed
Implemented feedback from John and Shilpa
1 parent e7cf57d commit 40faff7

3 files changed

Lines changed: 14 additions & 10 deletions

File tree

doc/OnlineDocs/explanation/analysis/doe/guide.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ MBDoE analysis. This is in line with the convention used in the parameter estima
1616

1717
An example of the subclassed :class:`Experiment` object that builds and labels the model is shown in the next few sections.
1818

19-
This guide illustrates the use of Pyomo.DoE using a reaction kinetics example (Wang and Dowling, 2022).
19+
This guide illustrates the use of Pyomo.DoE using a reaction kinetics example ([WD22]_).
2020

2121
.. math::
2222
:nowrap:
@@ -117,17 +117,17 @@ Step 5: Exploratory analysis (Enumeration)
117117
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
118118

119119
After creating the subclass of the :class:`Experiment` class, exploratory analysis is
120-
suggested to enumerate the design space to check if the problem is identifiable,
121-
i.e., ensure that D-, E-optimality metrics are not small numbers near zero, and
122-
Modified E-optimality is not a big number.
120+
suggested to systematically enumerate the experimental design space and identify regions
121+
that provide high information content about the model parameters, as quantified by
122+
the A-, D-, E-, and ME-optimality criteria.
123123
Additionally, it helps to initialize the model for the optimal experimental design step.
124124

125-
Pyomo.DoE can perform exploratory sensitivity analysis with the ``compute_FIM_full_factorial`` method.
126-
The ``compute_FIM_full_factorial`` method generates a grid over the design space as specified by the user.
127-
Each grid point represents an MBDoE problem solved using the ``compute_FIM`` method.
125+
Pyomo.DoE can perform exploratory sensitivity analysis with the :meth:`compute_FIM_full_factorial` method.
126+
The :meth:`compute_FIM_full_factorial` method generates a grid over the design space as specified by the user.
127+
Each grid point represents an MBDoE problem solved using the :meth:`compute_FIM` method.
128128
In this way, sensitivity of the FIM over the design space can be evaluated.
129-
Pyomo.DoE supports plotting the results from the ``compute_FIM_full_factorial`` method
130-
with the ``draw_factorial_figure`` method.
129+
Pyomo.DoE supports plotting the results from the :meth:`compute_FIM_full_factorial` method
130+
with the :meth:`draw_factorial_figure` method.
131131

132132
The following code defines the ``run_reactor_doe`` function. This function encapsulates
133133
the workflow for both sensitivity analysis (Step 5) and optimal design (Step 6).

doc/OnlineDocs/explanation/analysis/doe/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,4 @@ We can use the FIM or the covariance matrix to define the design criteria.
127127
A confidence ellipse is a geometric representation of the uncertainty in parameter
128128
estimates. It is derived from the covariance matrix :math:`\mathbf{V}`.
129129

130-
In order to solve problems of the above, Pyomo.DoE implements the 2-stage stochastic program. Please see Wang and Dowling (2022) for details.
130+
In order to solve problems of the above, Pyomo.DoE implements the 2-stage stochastic program. Please see [WD22]_ for details.

doc/OnlineDocs/reference/bibliography.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,7 @@ Bibliography
179179
180180
.. [NW99] Nocedal, Jorge, and Stephen J. Wright, eds. Numerical
181181
optimization. New York, NY: Springer New York, 1999.
182+
183+
.. [WD22] Wang, Jialu, and Alexander W. Dowling. "Pyomo.DOE: An open‐source
184+
package for model‐based design of experiments in Python." *AIChE Journal*,
185+
68(12), e17813. 2022. DOI `10.1002/aic.17813Y <https://doi.org/10.1002/aic.17813Y>`_

0 commit comments

Comments
 (0)