5.2.13. Options for Report Section¶
The options below are the available options in the Report Section of the pyfun.json control file
- Reports: {
None} |list[str] list of reports
- Sweeps: {
None} |dict collection of sweep definitions
- Subfigures: {
None} |dict collection of subfigure definitions
- Figures: {
None} |dict collection of figure definitions
5.2.13.1. Options for all Figures¶
5.2.13.2. Options for all Subfigures¶
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.1. CoeffTable Options¶
- CN: {
['mu', 'std']} |list[str] value of option “CN”
- Coefficients: {
None} |list[str] list of coefficients to detail in table
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- CY: {
['mu', 'std']} |list[str] value of option “CY”
- Components: {
None} |list[str] list of components for which to report coefficients
- Header: {
''} |str subfigure header
- Iteration: {
None} |int|int32|int64 specific iteration at which to sample results
- CLL: {
['mu', 'std']} |list[str] value of option “CLL”
- CLM: {
['mu', 'std']} |list[str] value of option “CLM”
- EpsFormat: {
None} |str printf-style text format for sampling error
- MuFormat: {
None} |str printf-style text format for mean value
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- CLN: {
['mu', 'std']} |list[str] value of option “CLN”
- SigmaFormat: {
None} |str printf-sylte text format for standard deviation
- CA: {
['mu', 'std']} |list[str] value of option “CA”
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.2. Conditions Options¶
- SkipVars: {
None} |list[str] list of run matrix keys to leave out of table
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- Header: {
''} |str subfigure header
- SpecialVars: {
None} |list[str] keys not in run matrix to attempt to calculate
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.3. ConditionsTable Options¶
- SkipVars: {
None} |list[str] list of run matrix keys to leave out of table
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- Header: {
''} |str subfigure header
- SpecialVars: {
None} |list[str] keys not in run matrix to attempt to calculate
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.4. ContourCoeff Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- ContourOptions: {
None} |dict options passed to contour plot function
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- ContourType:
'tricontour'| {'tricontourf'} |'tripcolor' contour plotting function/type to use
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
None} |object iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- XCol: {
None} |str run matrix key to use for x-axis
- AxisEqual: {
True} |bool|bool_ option to scale x and y axes with common scale
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- ContourColorMap: {
'jet'} |str name of color map to use w/ contour plots
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |ContourCoeffPlotOpts options for main line(s) of plot
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- ColorBar: {
True} |bool|bool_ option to turn on color bar (scale)
- YCol: {
None} |str run matrix key to use for y-axis
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Alignment: {
'center'} |object value of option “Alignment”
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- LineType: {
'plot'} |'triplot' plot function to use to mark data points
5.2.13.2.5. FMTable Options¶
- CN: {
['mu', 'std']} |list[str] value of option “CN”
- Coefficients: {
None} |list[str] list of coefficients to detail in table
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- CY: {
['mu', 'std']} |list[str] value of option “CY”
- Components: {
None} |list[str] list of components for which to report coefficients
- Header: {
''} |str subfigure header
- Iteration: {
None} |int|int32|int64 specific iteration at which to sample results
- CLL: {
['mu', 'std']} |list[str] value of option “CLL”
- CLM: {
['mu', 'std']} |list[str] value of option “CLM”
- EpsFormat: {
None} |str printf-style text format for sampling error
- MuFormat: {
None} |str printf-style text format for mean value
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- CLN: {
['mu', 'std']} |list[str] value of option “CLN”
- SigmaFormat: {
None} |str printf-sylte text format for standard deviation
- CA: {
['mu', 'std']} |list[str] value of option “CA”
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.6. Image Options¶
- ImageFile: {
'export.png'} |str name of image file to copy from case folder
- Caption: {
None} |str subfigure caption
- Width: {
0.5} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- Type: {
None} |str subfigure type or parent
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.7. Paraview Options¶
- Caption: {
None} |str subfigure caption
- Layout: {
'layout.py'} |str name of Python file to execute with Paraview
- Type: {
None} |str subfigure type or parent
- Alignment: {
'center'} |object value of option “Alignment”
- ImageFile: {
'export.png'} |str name of image file created by Layout
- Format: {
'png'} |str image file format
- Width: {
0.5} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- Command: {
'pvpython'} |str name of Python/Paraview executable to call
5.2.13.2.8. PlotCoeff Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- NPlotLast: {
None} |int|int32|int64 value of option “NPlotLast”
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- MuFormat: {
'%.4f'} |str printf-style flag for ShowMu value
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
1} |int|int32|int64 iteration at which to start figure
- EpsilonPlotOptions: {
None} |PlotCoeffIterEpsilonPlotOpts value of option “EpsilonPlotOptions”
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- EpsilonFormat: {
'%.4f'} |str printf-style flag for ShowEpsilon value
- MuPlotOptions: {
None} |PlotCoeffIterMuPlotOpts plot options for horizontal line showing mean
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- Coefficient: {
None} |object value of option “Coefficient”
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- ShowDelta: {
[True, False]} |bool|bool_ option to print value of Delta
- DeltaFormat: {
'%.4f'} |str printf-style flag for ShowDelta value
- KEpsilon: {
0.0} |float|float32 multiple of iterative error to plot
- NPlotIters: {
None} |int|int32|int64 value of option “NPlotIters”
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- KSigma: {
None} |object value of option “KSigma”
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- ShowMu: {
[True, False]} |bool|bool_ option to print value of mean over window
- YLabel: {
None} |str manual label for y-axis
- Component: {
None} |object value of option “Component”
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- SigmaPlotOptions: {
None} |object value of option “SigmaPlotOptions”
- DeltaPlotOptions: {
None} |PlotCoeffIterDeltaPlotOpts plot options for fixed-width above and below mu
- ShowEpsilon: {
False} |bool|bool_ option to print value of iterative sampling error
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |PlotCoeffIterPlotOpts options for main line(s) of plot
- Delta: {
0.0} |float|float32 specified interval(s) to plot above and below mean
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- YLabelOptions: {
None} |dict text options for y-axis label
- SigmaFormat: {
'%.4f'} |object printf-style flag for ShowSigma value
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- ShowSigma: {
[True, False]} |bool|bool_ option to print value of standard deviation
- NAverage: {
None} |int|int32|int64 value of option “NAverage”
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- CaptionComponent: {
None} |str explicit text for component portion of caption
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.9. PlotCoeffIter Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- NPlotLast: {
None} |int|int32|int64 value of option “NPlotLast”
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- MuFormat: {
'%.4f'} |str printf-style flag for ShowMu value
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
1} |int|int32|int64 iteration at which to start figure
- EpsilonPlotOptions: {
None} |PlotCoeffIterEpsilonPlotOpts value of option “EpsilonPlotOptions”
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- EpsilonFormat: {
'%.4f'} |str printf-style flag for ShowEpsilon value
- MuPlotOptions: {
None} |PlotCoeffIterMuPlotOpts plot options for horizontal line showing mean
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- Coefficient: {
None} |object value of option “Coefficient”
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- ShowDelta: {
[True, False]} |bool|bool_ option to print value of Delta
- DeltaFormat: {
'%.4f'} |str printf-style flag for ShowDelta value
- KEpsilon: {
0.0} |float|float32 multiple of iterative error to plot
- NPlotIters: {
None} |int|int32|int64 value of option “NPlotIters”
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- KSigma: {
None} |object value of option “KSigma”
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- ShowMu: {
[True, False]} |bool|bool_ option to print value of mean over window
- YLabel: {
None} |str manual label for y-axis
- Component: {
None} |object value of option “Component”
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- SigmaPlotOptions: {
None} |object value of option “SigmaPlotOptions”
- DeltaPlotOptions: {
None} |PlotCoeffIterDeltaPlotOpts plot options for fixed-width above and below mu
- ShowEpsilon: {
False} |bool|bool_ option to print value of iterative sampling error
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |PlotCoeffIterPlotOpts options for main line(s) of plot
- Delta: {
0.0} |float|float32 specified interval(s) to plot above and below mean
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- YLabelOptions: {
None} |dict text options for y-axis label
- SigmaFormat: {
'%.4f'} |object printf-style flag for ShowSigma value
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- ShowSigma: {
[True, False]} |bool|bool_ option to print value of standard deviation
- NAverage: {
None} |int|int32|int64 value of option “NAverage”
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- CaptionComponent: {
None} |str explicit text for component portion of caption
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.10. PlotCoeffSweep Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
None} |object iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- Coefficient: {
None} |object value of option “Coefficient”
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- KSigma: {
None} |object value of option “KSigma”
- YLim: {
None} |object explicit min and max limits for y-axis
- MinMax: {
False} |bool|bool_ option to plot min/max of value over iterative window
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- Component: {
None} |object value of option “Component”
- Target: {
None} |str name of target databook to co-plot
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- SigmaPlotOptions: {
None} |object value of option “SigmaPlotOptions”
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |PlotCoeffSweepPlotOpts options for main line(s) of plot
- TargetOptions: {
None} |PlotCoeffSweepTargetPlotOpts plot options for optional target
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- MinMaxOptions: {
None} |PlotCoeffSweepMinMaxPlotOpts plot options for MinMax plot
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.11. PlotContour Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- ContourOptions: {
None} |dict options passed to contour plot function
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- ContourType:
'tricontour'| {'tricontourf'} |'tripcolor' contour plotting function/type to use
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
None} |object iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- XCol: {
None} |str run matrix key to use for x-axis
- AxisEqual: {
True} |bool|bool_ option to scale x and y axes with common scale
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- ContourColorMap: {
'jet'} |str name of color map to use w/ contour plots
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |ContourCoeffPlotOpts options for main line(s) of plot
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- ColorBar: {
True} |bool|bool_ option to turn on color bar (scale)
- YCol: {
None} |str run matrix key to use for y-axis
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Alignment: {
'center'} |object value of option “Alignment”
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- LineType: {
'plot'} |'triplot' plot function to use to mark data points
5.2.13.2.12. PlotContourSweep Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- ContourOptions: {
None} |dict options passed to contour plot function
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- ContourType:
'tricontour'| {'tricontourf'} |'tripcolor' contour plotting function/type to use
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
None} |object iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- XCol: {
None} |str run matrix key to use for x-axis
- AxisEqual: {
True} |bool|bool_ option to scale x and y axes with common scale
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- ContourColorMap: {
'jet'} |str name of color map to use w/ contour plots
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |ContourCoeffPlotOpts options for main line(s) of plot
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- ColorBar: {
True} |bool|bool_ option to turn on color bar (scale)
- YCol: {
None} |str run matrix key to use for y-axis
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Alignment: {
'center'} |object value of option “Alignment”
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- LineType: {
'plot'} |'triplot' plot function to use to mark data points
5.2.13.2.13. PlotL1 Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- NPlotLast: {
None} |int|int32|int64 value of option “NPlotLast”
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Residual: {
'L1'} |str name of residual field or type to plot
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
1} |int|int32|int64 iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- NPlotIters: {
None} |int|int32|int64 value of option “NPlotIters”
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |ResidPlotOpts options for main line(s) of plot
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- PlotOptions0: {
None} |ResidPlot0Opts plot options for initial residual
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.14. PlotL2 Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- NPlotLast: {
None} |int|int32|int64 value of option “NPlotLast”
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Residual: {
'L2'} |str name of residual field or type to plot
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
1} |int|int32|int64 iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- NPlotIters: {
None} |int|int32|int64 value of option “NPlotIters”
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |ResidPlotOpts options for main line(s) of plot
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- PlotOptions0: {
None} |ResidPlot0Opts plot options for initial residual
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.15. PlotLineLoad Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- AutoUpdate: {
True} |bool|bool_ option to create line loads if not in databook
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- SeamLocation:
'bottom'|'left'|'right'|'top' location for optional seam curve plot
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- SubplotMargin: {
0.015} |float|float32 margin between line load and seam curve subplots
- SeamCurve:
'smy'|'smz' name of seam curve, if any, to show w/ line loads
- NPlotFirst: {
None} |object iteration at which to start figure
- Coefficient: {
None} |str coefficient to plot
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- SeamOptions: {
None} |PlotLineLoadSeamPlotOpts plot options for optional seam curve
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- XPad: {
0.03} |float|float32 additional padding from data to xmin and xmax w/i axes
- AdjustRight: {
0.97} |float|float32 margin from axes to right of figure
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- Component: {
None} |str config component tp plot
- Orientation:
'horizontal'| {'vertical'} orientation of vehicle in line load plot
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- YPad: {
0.03} |float|float32 additional padding from data to ymin and ymax w/i axes
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |PlotLineLoadPlotOpts options for main line(s) of plot
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- AdjustTop: {
0.97} |float|float32 margin from axes to top of figure
- AdjustBottom: {
0.1} |float|float32 margin from axes to bottom of figure
- AdjustLeft: {
0.12} |float|float32 margin from axes to left of figure
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.16. PlotResid Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- NPlotLast: {
None} |int|int32|int64 value of option “NPlotLast”
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Residual: {
'L2'} |str name of residual field or type to plot
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
1} |int|int32|int64 iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- NPlotIters: {
None} |int|int32|int64 value of option “NPlotIters”
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- YLim: {
None} |object explicit min and max limits for y-axis
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |ResidPlotOpts options for main line(s) of plot
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- PlotOptions0: {
None} |ResidPlot0Opts plot options for initial residual
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.17. Summary Options¶
- CN: {
['mu', 'std']} |list[str] value of option “CN”
- Coefficients: {
None} |list[str] list of coefficients to detail in table
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- CY: {
['mu', 'std']} |list[str] value of option “CY”
- Components: {
None} |list[str] list of components for which to report coefficients
- Header: {
''} |str subfigure header
- Iteration: {
None} |int|int32|int64 specific iteration at which to sample results
- CLL: {
['mu', 'std']} |list[str] value of option “CLL”
- CLM: {
['mu', 'std']} |list[str] value of option “CLM”
- EpsFormat: {
None} |str printf-style text format for sampling error
- MuFormat: {
None} |str printf-style text format for mean value
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- CLN: {
['mu', 'std']} |list[str] value of option “CLN”
- SigmaFormat: {
None} |str printf-sylte text format for standard deviation
- CA: {
['mu', 'std']} |list[str] value of option “CA”
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.18. SweepCases Options¶
- SkipVars: {
None} |list[str] list of run matrix keys to leave out of table
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- Header: {
''} |str subfigure header
- SpecialVars: {
None} |list[str] keys not in run matrix to attempt to calculate
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.19. SweepCoeff Options¶
- XLim: {
None} |object explicit min and max limits for x-axis
- Caption: {
None} |str subfigure caption
- XTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis ticks or set values
- YTicks: {
None} |float|float16|float32|float64|float128|bool|bool_ option to turn off y-axis ticks or set values
- Type: {
None} |str subfigure type or parent
- XTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- TickLabels: {
None} |bool|bool_ common value(s) for ticks of both axes
- YTickLabelOptions: {
None} |dict text options for y-axis tick labels
- Format: {
'pdf'} |'svg'|'png'|'jpg'|'jpeg' image file format
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- NPlotFirst: {
None} |object iteration at which to start figure
- XLimMax: {
None} |object outer limits for min and max x-axis limits
- Coefficient: {
None} |object value of option “Coefficient”
- XLabel: {
None} |str manual label for x-axis
- RestrictionOptions: {
{}} |dict additional opts to
text()for restriction- XMin: {
None} |float|float32 explicit lower limit for x-axis limits
- RestrictionYPosition: {
None} |float|float32 explicit y-coord of restriction
- FigureHeight: {
4.5} |float|float32 height of subfigure graphics in inches
- YLimMax: {
None} |object outer limits for min and max y-axis limits
- FigureWidth: {
6} |float|float32 width of subfigure graphics in inches
- TickLabelOptions: {
None} |dict common options for ticks of both axes
- KSigma: {
None} |object value of option “KSigma”
- YLim: {
None} |object explicit min and max limits for y-axis
- MinMax: {
False} |bool|bool_ option to plot min/max of value over iterative window
- XTickLabelOptions: {
None} |dict text options for x-axis tick labels
- YLabel: {
None} |str manual label for y-axis
- Component: {
None} |object value of option “Component”
- Target: {
None} |str name of target databook to co-plot
- XMax: {
None} |float|float32 explicit upper limit for x-axis limits
- SigmaPlotOptions: {
None} |object value of option “SigmaPlotOptions”
- Ticks: {
None} |bool|bool_ value of option “Ticks”
- PlotOptions: {
None} |PlotCoeffSweepPlotOpts options for main line(s) of plot
- TargetOptions: {
None} |PlotCoeffSweepTargetPlotOpts plot options for optional target
- RestrictionLoc:
'bottom'|'bottom left'|'bottom right'|'left'|'lower right'|'lower left'|'right'| {'top'} |'top left'|'top right'|'upper left'|'upper right' location for subfigure restriction text
- MinMaxOptions: {
None} |PlotCoeffSweepMinMaxPlotOpts plot options for MinMax plot
- YLabelOptions: {
None} |dict text options for y-axis label
- YTickLabels: {
None} |str|float|float16|float32|float64|float128|bool|bool_ option to turn off x-axis tick labels or set values
- Ymin: {
None} |object value of option “Ymin”
- XLabelOptions: {
None} |dict text options for x-axis label
- YMax: {
None} |float|float32 explicit upper limit for y-axis limits
- Restriction: {
''} |str data restriction to place on figure
- DPI: {
150} |int|int32|int64 dots per inch if saving as rasterized image
- Width: {
None} |float|float32 value of option “Width”
- RestrictionXPosition: {
None} |float|float32 explicit x-coord of restriction
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.20. SweepConditions Options¶
- SkipVars: {
None} |list[str] list of run matrix keys to leave out of table
- Caption: {
None} |str subfigure caption
- Type: {
None} |str subfigure type or parent
- Header: {
''} |str subfigure header
- SpecialVars: {
None} |list[str] keys not in run matrix to attempt to calculate
- Width: {
None} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.2.21. Tecplot Options¶
- ColorMaps: {
[]} |list[dict] customized Tecplot colormap
- Caption: {
None} |str subfigure caption
- Layout: {
None} |str template Tecplot layout file
- Type: {
None} |str subfigure type or parent
- VarSet: {
{}} |dict variables and their values to define in Tecplot layout
- FieldMap: {
None} |list[int|int32|int64] list of zone numbers for Tecplot layout group boundaries
- Width: {
0.5} |float|float32 value of option “Width”
- Position:
't'|'c'| {'b'} subfigure vertical alignment
- FigWidth: {
1024} |int|int32|int64 width of output image in pixels
- Keys: {
None} |dict dict of Tecplot layout statements to customize
- ContourLevels: {
None} |list[dict] customized settings for Tecplot contour levels
- Alignment: {
'center'} |object value of option “Alignment”
5.2.13.3. Options for all Sweeps¶
- YCol: {
None} |str run matrix key to use for y-axis of sweep contour plots
- XCol: {
None} |str run matrix key to use for x-axis of sweep plots
- Figures: {
None} |list[str] list of figures in sweep report
- TolCons: {
None} |dict tolerances for run matrix keys to be in same sweep
- CarpetEqCons: {
None} |list[str] run matrix keys that are constant on carpet subsweep
- GlobalCons: {
None} |list[str] list of global constraints for sweep
- MinCases: {
3} |int|int32|int64 minimum number of data points in a sweep to include plot
- Indices: {
None} |list[int|int32|int64] explicit list of run matrix/databook indices to include
- EqCons: {
None} |list[str] list of run matrix keys that must be constant on a sweep
- IndexTol: {
None} |int|int32|int64 max delta of run matrix/databook index for single sweep
- RunMatrixOnly: {
False} |bool|bool_ option to restrict databook to current run matrix
