cape.pyover.pointsensor: OVERFLOW point sensor data interface

This module provides an interface to read and process point sensor data from OVERFLOW simulations.

class cape.pyover.pointsensor.PointSensorDataBook(x, opts, pt, name=None, **kw)

Bases: DataBookComp

Point sensor data book

Call:

>>> DBP = PointSensorDataBook(x, opts, pt, name=None)

Inputs:

x: cape.runmatrix.RunMatrix

RunMatrix/run matrix interface

opts: cape.options.Options

Options interface

pt: str

Name of point

name: str | None

Name of data book item (defaults to pt)

RootDir: str | None

Project root directory absolute path, default is PWD

Outputs:

DBP: pyCart.pointsensor.PointSensorDataBook

An individual point sensor data book

Versions:

• 2016-02-17 @ddalle: Started

PlotValueHist(coeff, I, **kw)

Plot a histogram of one coefficient over several cases

Call:

>>> h = DBi.PlotHist(coeff, I, **kw)

Inputs:

DB: databook.DataBookComp

Instance of the data book component class

coeff: str

Coefficient being plotted

I: numpy.ndarray[int]

List of indexes of cases to include in sweep

Keyword Arguments:

Label: [ {comp} | str ]

Manually specified label

TargetValue: float | list[float]

Target or list of target values

TargetLabel: str | list[str]

Legend label(s) for target(s)

StDev: [ {None} | float ]

Multiple of iterative history standard deviation to plot

HistOptions: dict

Plot options for the primary histogram

StDevOptions: dict

Dictionary of plot options for the standard deviation plot

DeltaOptions: dict

Options passed to pltfile.plot() for reference range plot

MeanOptions: dict

Options passed to pltfile.plot() for mean line

TargetOptions: dict

Options passed to pltfile.plot() for target value lines

ShowMu: bool

Option to print value of mean

ShowSigma: bool

Option to print value of standard deviation

ShowEpsilon: bool

Option to print value of sampling error

ShowDelta: bool

Option to print reference value

ShowTarget: bool

Option to show target value

MuFormat: {"%.4f"} | str

Format for text label of the mean value

DeltaFormat: {"%.4f"} | str

Format for text label of the reference value d

SigmaFormat: {"%.4f"} | str

Format for text label of the iterative standard deviation

TargetFormat: {"%.4f"} | str

Format for text label of the target value

XLabel: str

Specified label for x-axis, default is Iteration Number

YLabel: str

Specified label for y-axis, default is c

Outputs:

h: dict

Dictionary of plot handles

Versions:

• 2015-05-30 @ddalle: First version

• 2015-12-14 @ddalle: Added error bars

UpdateCase(i)

Prepare to update one point sensor case if necessary

Call:

>>> DBP.UpdateCase(i)

Inputs:

DBP: pyCart.pointsensor.PointSensorDataBook

An individual point sensor data book

i: int

Case index

Versions:

• 2016-02-17 @ddalle: Placeholder

class cape.pyover.pointsensor.PointSensorGroupDataBook(x, opts, name, **kw)

Bases: dict

Point sensor group data book

Call:

>>> DBPG = PointSensorGroupDataBook(x, opts, name)

Inputs:

x: cape.runmatrix.RunMatrix

RunMatrix/run matrix interface

opts: cape.options.Options

Options interface

name: str | None

Name of data book item (defaults to pt)

RootDir: str | None

Project root directory absolute path, default is PWD

Outputs:

DBPG: pyOver.pointsensor.PointSensorGroupDataBook

A point sensor group data book

Versions:

• 2015-12-04 @ddalle: First version

Sort()

Sort point sensor group

Call:

>>> DBPG.Sort()

Inputs:

DBPG: pyCart.pointsensor.PointSensorGroupDataBook

A point sensor group data book

Versions:

• 2016-03-08 @ddalle: First version

UpdateCase(i)

Prepare to update one point sensor case if necessary

Call:

>>> DBPG.UpdateCase(i)

Inputs:

DBPG: pyOver.pointsensor.PointSensorGroupDataBook

A point sensor group data book

i: int

Case index

Versions:

• 2016-02-17 @ddalle: Placeholder

UpdateRunMatrix()

Match the trajectory to the cases in the data book

Call:

>>> DBPG.UpdateRunMatrix()

Inputs:

DBPG: pyCart.pointsensor.PointSensorGroupDataBook

A point sensor group data book

Versions:

• 2015-05-22 @ddalle: First version

Write()

Write to file each point sensor data book in a group

Call:

>>> DBPG.Write()

Inputs:

DBPG: pyCart.pointsensor.PointSensorGroupDataBook

A point sensor group data book

Versions:

• 2015-12-04 @ddalle: First version