3.1.9.3.1. _default_: definition for a condition sweep in a CAPE report¶
Option aliases:
EqConstraints → EqCons
EqualityCons → EqCons
EqualityConstraints → EqCons
GlobalConstraints → GlobalCons
TolConstraints → TolCons
ToleranceConstraints → TolCons
XAxis → XCol
YAxis → YCol
cols → EqCons
cons → GlobalCons
figs → Figures
itol → IndexTol
mask → Indices
nmin → MinCases
tols → TolCons
xcol → XCol
xk → XCol
xkey → XCol
yk → YCol
ykey → YCol
Recognized options:
- CarpetEqCons: {
None} |list[str] run matrix keys that are constant on carpet subsweep
- EqCons: {
None} |list[str] list of run matrix keys that must be constant on a sweep
- Figures: {
None} |list[str] list of figures in sweep report
- GlobalCons: {
None} |list[str] list of global constraints for sweep
- IndexTol: {
None} |int max delta of run matrix/databook index for single sweep
- Indices: {
None} |list[int] explicit list of run matrix/databook indices to include
- MinCases: {
3} |int minimum number of data points in a sweep to include plot
- RunMatrixOnly: {
False} |True option to restrict databook to current run matrix
- TolCons: {
None} |dict tolerances for run matrix keys to be in same sweep
- XCol: {
None} |str run matrix key to use for x-axis of sweep plots
- YCol: {
None} |str run matrix key to use for y-axis of sweep contour plots
