cape.cfdx.options.DataBook: Data book options¶
This module contains the basic interface for data book options generic to all
solvers. Some options are not generic, and so the derivative options classes
such as pyCart.options.DataBook.DataBook have additional methods.
Each data book component type has its options controlled by this options
method. Despite the fact that line load data books have their own data module,
cape.cfdx.lineLoad, which is separate from the main cape.cfdx.dataBook,
all options are controlled within one module.
- class cape.cfdx.options.DataBook.DataBook(fname=None, **kw)¶
Dictionary-based interface for DataBook specifications
- Call:
>>> opts = DataBook(**kw)
- Inputs:
- kw:
dict Dictionary of options
- kw:
- Outputs:
- opts:
cape.options.DataBook.DataBook Data book options interface
- opts:
- Versions:
2014-12-20
@ddalle: Version 1.0
- add_PlotComponents(comps)¶
Add to the list of components to plot
- Call:
>>> opts.add_PlotComponents(comps)
- Inputs:
- opts:
cape.options.Options Options interface
- comps:
list[str|int] List of components (names or numbers) to plot
- opts:
- Versions:
2014-11-23
@ddalle: Version 1.0
- apply_umask(sys=True)¶
Apply the permissions filter
- Call:
>>> opts.apply_umask(sys=True)
- Inputs:
- opts
cape.options.Options Options interface
- sys: {
True} |False Whether or not to use system setting as default
- opts
- Versions:
2015-09-27
@ddalle: Version 1.02017-09-05
@ddalle: Added sys input variable
- get_CompTargets(comp)¶
Get the list of targets for a specific data book component
- Call:
>>> targs = opts.get_CompTargets(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- targs:
list[str] List of targets for that component
- targs:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_DBGroupPoints(name)¶
Get the list of points in a group
For example, get the list of point sensors in a point sensor group
- Call:
>>> pts = opts.get_DBGroupPoints(name)
- Inputs:
- opts:
cape.options.Options Options interface
- name:
str Name of data book group
- opts:
- Outputs:
- pts:
list[str] List of points (by name) in the group
- pts:
- Versions:
2015-12-04
@ddalle: Version 1.02016-02-17
@ddalle: Moved to CAPE
- get_DataBookAbsProjTol(comp)¶
Get absolute projection tolerance, not affected by component scale
- Call:
>>> antol = opts.get_DataBookAbsProjTol(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- antol:
float Absolute distance tolerance for TriqFM projection
- antol:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookAbsTol(comp)¶
Get absolute tangent tolerance, not affected by component scale
- Call:
>>> atol = opts.get_DataBookAbsTol(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- atol:
float Absolute tangential distance tolerance for TriqFM
- atol:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookByGlob(typ, comp=None)¶
Get list of components by type and list of wild cards
- Call:
>>> comps = opts.get_DataBookByGlob(typ, comp)
- Inputs:
- opts:
cape.options.Options Options interface
- typ: FM | Force | Moment | LineLoad | TriqFM
Data book type
- comp: {
None} |str List of component wild cards, separated by commas
- opts:
- Outputs:
- comps:
str All components meeting one or more wild cards
- comps:
- Versions:
2017-04-25
@ddalle: Version 1.0
- get_DataBookByType(typ)¶
Get the list of data book components with a given type
- Call:
>>> comps = opts.get_DataBookByType(typ)
- Inputs:
- opts:
cape.options.Options Options interface
- typ:
"Force"|"FM"|"LineLoad"|str Data book type
- opts:
- Outputs:
- comps:
list[str] List of data book components with
"Type"matching typ
- comps:
- Versions:
2016-06-07
@ddalle: Version 1.0
- get_DataBookCoeffStats(comp, coeff)¶
Get the list of statistical properties for a specific coefficient
- Call:
>>> sts = opts.get_DataBookCoeffStats(comp, coeff)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of data book component
- coeff:
str Name of data book coefficient, e.g. “CA”, “CY”, etc.
- opts:
- Outputs:
- sts:
list(mu | std | min | max | err) List of statistical properties for this coefficient
- sts:
- Versions:
2016-03-15
@ddalle: Version 1.0
- get_DataBookCoeffs(comp)¶
Get the list of data book coefficients for a specific component
- Call:
>>> coeffs = opts.get_DataBookCoeffs(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- coeffs:
list[str] List of coefficients for that component
- coeffs:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_DataBookCols(comp)¶
Get the full list of data book columns for a specific component
This includes the list of coefficients, e.g.
['CA', 'CY', 'CN']; statistics such as'CA_min'if nStats is greater than 0; and targets such as'CA_t'if there is a target for CA.- Call:
>>> cols = opts.get_DataBookCols(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- cols:
list[str] List of coefficients and other columns for that coefficient
- cols:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_DataBookCompID(comp)¶
Get list of components in a data book component
- Call:
>>> compID = opts.get_DataBookCompID(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of data book component/field
- opts:
- Outputs:
- compID:
str|int|list Component or list of components to which this DB applies
- compID:
- Versions:
2016-06-07
@ddalle: Version 1.0
- get_DataBookCompProjTol(comp)¶
Get projection tolerance relative to size of component
- Call:
>>> cntol = opts.get_DataBookCompProjTol(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- cntol:
float Projection distance tolerance relative to comp BBox
- cntol:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookCompTol(comp)¶
Get tangent tolerance relative to component
- Call:
>>> rtol = opts.get_DataBookCompTol(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- rtol:
float Tangential distance tolerance relative to component BBox
- rtol:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookComponents(targ=None)¶
Get the list of components to be used for the data book
- Call:
>>> comps = opts.get_DataBookComponents(targ=None)
- Inputs:
- opts:
cape.options.Options Options interface
- targ: {
None} |str Name of target to use non-global component list
- opts:
- Outputs:
- comps:
list List of components
- comps:
- Versions:
2014-12-20
@ddalle: Version 1.02017-01-17
@ddalle: Added targ input
- get_DataBookConfigCompID(comp)¶
Get config file for the original mesh or unmapped tri file
- Call:
>>> compID = opts.get_DataBookConfigCompID(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- compID: {
None} |int|str|list Component from pre-mapped tri file
- compID: {
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookConfigFile(comp)¶
Get config file for the original mesh or unmapped tri file
- Call:
>>> fcfg = opts.get_DataBookConfigFile(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- fcfg:
str Name of configuration file
- fcfg:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookDataCols(comp)¶
Get the list of data book columns for a specific component
This includes the list of coefficients, e.g.
['CA', 'CY', 'CN']; statistics such as'CA_min'if nStats is greater than 0.- Call:
>>> cols = opts.get_DataBookDataCols(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- cols:
list[str] List of coefficients and other columns for that coefficient
- cols:
- Versions:
2014-12-21
@ddalle: Version 1.02022-04-08
@ddalle: Version 2.0; cooeff-spec suffixes
- get_DataBookDir()¶
Get the folder that holds the data book
- Call:
>>> fdir = opts.get_DataBookDir()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- fdir:
str Relative path to data book folder
- fdir:
- Versions:
2014-12-20
@ddalle: Version 1.0
- get_DataBookExtension(comp)¶
Get the file extension for a data book component
- Call:
>>> ext = opts.get_DataBookExtension(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- ext:
str File extension
- ext:
- Versions:
2016-06-07
@ddalle: Version 1.0
- get_DataBookFloatCols(comp)¶
Get additional numeric columns for component (other than coeffs)
- Call:
>>> fcols = opts.get_DataBookFloatCols(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of data book component
- opts:
- Outputs:
- fcols:
list[str] List of additional float columns
- fcols:
- Versions:
2016-03-15
@ddalle: Version 1.0
- get_DataBookFunction(comp)¶
Get function name for PyFunc component
- Call:
>>> funcname = opts.get_DataBookFunction(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- funcname:
str Name of function to use for this component
- funcname:
- Versions:
2022-04-13
@ddalle: Version 1.0
- get_DataBookGauge(comp)¶
Get ‘Gauge’ flag for a data book component
- Call:
>>> qg = opts.get_DataBookGauge(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- qg: {
True} |False Option to use gauge forces (freestream pressure as reference)
- qg: {
- Versions:
2017-03-29
@ddalle: Version 1.0
- get_DataBookIntCols(comp)¶
Get integer columns for component
- Call:
>>> fcols = opts.get_DataBookFloatCols(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of data book component
- opts:
- Outputs:
- fcols:
list[str] List of additional float columns
- fcols:
- Versions:
2016-03-15
@ddalle: Version 1.0
- get_DataBookLineLoads()¶
Get the list of sectional loads components in the data book
- Call:
>>> comps = opts.get_DataBookLineLoads()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- comps:
list List of components or line load groups
- comps:
- Versions:
2015-09-15
@ddalle: Version 1.0
- get_DataBookMapConfig(comp)¶
Get the GMP XML file for mapping component IDs to names or interpreting the component names of a remapping TRI file
- Call:
>>> fcfg = opts.get_DataBookMapConfig(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component file
- opts:
- Outputs:
- fcfg: {
None} |str Name of config XML or JSON file, if any
- fcfg: {
- Versions:
2017-03-05
@ddalle: Version 1.0
- get_DataBookMapTri(comp)¶
Get the name of a triangulation file to use for remapping
triqtriangles to extract a component not defined in thetriqfile- Call:
>>> ftri = opts.get_DataBookMapTri(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component file
- opts:
- Outputs:
- ftri: {
None} |str Name of tri file relative to root directory
- ftri: {
- Versions:
2017-03-05
@ddalle: Version 1.0
- get_DataBookMapTriTol(comp)¶
Get dictionary of projection tolerances for
tri.MapTriCompID()- Call:
>>> tols = opts.get_DataBookMapTriTol(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- tols:
dict[float] Dict of relative and absolute tolerances for CompID mapping
- tols:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookMomentum(comp)¶
Get ‘Momentum’ flag for a data book component
- Call:
>>> qm = opts.get_DataBookMomentum(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- qm:
True| {False} Whether or not to include momentum
- qm:
- Versions:
2016-06-07
@ddalle: Version 1.0
- get_DataBookOutputFormat(comp)¶
Get any output format option for a data book component
- Call:
>>> fmt = opts.get_DataBookOutputFormat(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- fmt:
None|str File format for additional output
- fmt:
- Versions:
2017-03-28
@ddalle: Version 1.0
- get_DataBookPatches(comp)¶
Get list of patches for a databook component, usually for
TriqFM- Call:
>>> fpatches = opts.get_DataBookPatches(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component file
- opts:
- Outputs:
- fpatches:
list[str] List of names of patches, if any
- fpatches:
- Versions:
2017-03-28
@ddalle: Version 1.0
- get_DataBookPoints(comp)¶
Get the data book subcomponent for one target
For example, for “PointSensor” targets will return the list of points
- Call:
>>> pts = opts.get_DataBookPoints(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of data book component
- opts:
- Outputs:
- pts:
list[str] List of subcomponents
- pts:
- Versions:
2015-12-14
@ddalle: Version 1.0
- get_DataBookPrefix(comp)¶
Get the prefix to use for a data book component
- Call:
>>> fpre = opts.get_DataBookPrefix(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- fpre:
str Name of prefix
- fpre:
- Versions:
2016-06-07
@ddalle: Version 1.0
- get_DataBookRelProjTol(comp)¶
Get projection tolerance relative to size of geometry
- Call:
>>> rntol = opts.get_DataBookRelProjTol(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- rntol:
float Projection distance tolerance relative to total BBox
- rntol:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookRelTol(comp)¶
Get tangent tolerance relative to overall geometry scale
- Call:
>>> rtol = opts.get_DataBookRelTol(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- rtol:
float Tangential distance tolerance relative to total BBox
- rtol:
- Versions:
2017-04-07
@ddalle: Version 1.0
- get_DataBookSectionType(comp)¶
Get line load section type
- Call:
>>> typ = opts.get_DataBookSectionType(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- typ: {
"dlds"} |"slds"|"clds"|str Value of the
"SectionType"option
- typ: {
- Versions:
2016-06-09
@ddalle: Version 1.0
- get_DataBookTargetByName(targ)¶
Get a data book target option set by the name of the target
- Call:
>>> topts = opts.get_DataBookTargetByName(targ)
- Inputs:
- opts:
cape.options.Options Options interface
- targ:
str Name of the data book target
- opts:
- Outputs:
2015-12-15
@ddalle: Version 1.0
- get_DataBookTargetCols(comp)¶
Get the list of data book target columns for a specific component
- Call:
>>> cols = opts.get_DataBookDataCols(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- cols:
list[str] List of coefficient target values
- cols:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_DataBookTargetDir(targ)¶
Get the folder for a data book duplicate target
- Call:
>>> fdir = opts.get_DataBookTargetDir(targ)
- Inputs:
- opts:
cape.options.Options Options interface
- targ:
str Name of the data book target
- opts:
- Outputs:
- typ: {
"generic"} |"cape" Target type, generic CSV file or duplicate data book
- typ: {
- Versions:
2016-06-27
@ddalle: Version 1.0
- get_DataBookTargetType(targ)¶
Get the target data book type
This can be either a generic target specified in a single file or a Cape data book that has the same description as the present data book
- Call:
>>> typ = opts.get_DataBookTargetType(targ)
- Inputs:
- opts:
cape.options.Options Options interface
- targ:
str Name of the data book target
- opts:
- Outputs:
- typ: {
"generic"} |"cape" Target type, generic CSV file or duplicate data book
- typ: {
- Versions:
2016-06-27
@ddalle: Version 1.0
- get_DataBookTargets()¶
Get the list of targets to be used for the data book
- Call:
>>> targets = opts.get_DataBookTargets()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- targets:
dict[dict] Dictionary of targets
- targets:
- Versions:
2014-12-20
@ddalle: Version 1.0
- get_DataBookTransformations(comp)¶
Get the transformations required to transform a component’s data book into the body frame of that component.
- Call:
>>> tlist = opts.get_DataBookTransformations(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- tlist:
list[dict] List of targets for that component
- tlist:
- Versions:
2014-12-22
@ddalle: Version 1.0
- get_DataBookTrim(comp)¶
Get ‘Trim’ flag for a data book component
- Call:
>>> iTrim = opts.get_DataBookTrim(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- iTrim:
0| {1} Trim setting; no output if
None
- iTrim:
- Versions:
2016-06-07
@ddalle: Version 1.0
- get_DataBookTriqFormat(comp)¶
Get endianness and single/double for
triqfiles- Call:
>>> fmt = opts.get_DataBookTriqFormat(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Data book component name
- opts:
- Outputs:
- fmt:
ascii| {lb4} |b4|lb8|b8 File format for additional output
- fmt:
- Versions:
2017-03-28
@ddalle: Version 1.0
- get_DataBookType(comp)¶
Get the type of data book entry for one component
- Call:
>>> ctype = opts.get_DataBookType(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of component
- opts:
- Outputs:
- ctype: {Force} | Moment | FM | PointSensor | LineLoad
Data book entry type
- Versions:
2015-12-14
@ddalle: Version 1.0
- get_DataBook_nCut(comp)¶
Get the number of cuts to make for a sectional load group
- Call:
>>> nCut = opts.get_DataBook_nCut(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of line load group
- opts:
- Outputs:
- nCut:
int Number of cuts to include in line loads
- nCut:
- Versions:
2015-09-15
@ddalle: Version 1.0
- get_Delimiter()¶
Get the delimiter to use in files
- Call:
>>> delim = opts.get_Delimiter()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- delim:
str Delimiter to use in data book files
- delim:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_PlotCoeffs(comp=None)¶
Return the list of plot coefficients for a component
This applies the default from the “Plot” section of the options, but this is superseded by specific exceptions.
- Call:
>>> coeffs = opts.get_PlotCoeffs(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- coeffs:
list[str] List of coefficients to plot
- coeffs:
- Versions:
2014-11-22
@ddalle: Version 1.0
- get_PlotComponents()¶
Return the list of components to plot
- Call:
>>> comps = opts.get_PlotComponents()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- comps:
list[str|int] List of components (names or numbers) to plot
- comps:
- Versions:
2014-11-22
@ddalle: Version 1.0
- get_PlotDelta(coeff, comp=None)¶
Get the fixed-width interval to plot above and below the mean for a specific component and coefficient
- Call:
>>> dC = opts.get_PlotDelta(coeff, comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- coeff:
str Name of coefficient
- opts:
- Outputs:
- dC:
floatorNone Offset to plot from mean with dotted line
- dC:
- Versions:
2014-11-23
@ddalle: Version 1.0
- get_PlotFigHeight()¶
Get the figure height for plot
- Call:
>>> h = opts.get_PlotFigHeight()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- h:
float Figure height
- h:
- Versions:
2015-03-09
@ddalle: Version 1.0
- get_PlotFigWidth()¶
Get the figure width for plot
- Call:
>>> w = opts.get_PlotFigWidth()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- w:
float Figure width
- w:
- Versions:
2015-03-09
@ddalle: Version 1.0
- get_PlotRestriction(comp=None)¶
Return the number of columns to use in plots
- Call:
>>> sTag = opts.get_nPlotRestriction() >>> sTag = opts.get_nPlotRestriction(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- sTag: :
Number of columns of plots
- Versions:
2014-11-23
@ddalle: Version 1.0
- get_SortKey()¶
Get the key to use for sorting the data book
- Call:
>>> key = opts.get_SortKey()
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- key:
str|None|list[str] Name of key to sort with
- key:
- Versions:
2014-12-30
@ddalle: Version 1.0
- get_dmask(sys=True)¶
Get the permissions to assign to new folders
- Call:
>>> dmask = opts.get_dmask(sys=True)
- Inputs:
- opts
cape.options.Options Options interface
- sys: {
True} |False Whether or not to use system setting as default
- opts
- Outputs:
- dmask:
int|None New folder permissions mask
- dmask:
- Versions:
2015-09-27
@ddalle: Version 1.0
- get_dnStats(comp=None)¶
Get the increment in window sizes
- Call:
>>> dn = opts.get_dnStats(comp=None)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of specific data book to query
- opts:
- Outputs:
- dn:
int Increment in candidate window sizes
- dn:
- Versions:
2017-09-29
@ddalle: Version 1.0
- get_nAverage(comp=None)¶
Return the number of iterations to use for averaging
If there are fewer than nAvg iterations in the current history, all iterations will be plotted.
- Call:
>>> nAvg = opts.get_nAverage() >>> nAvg = opts.get_nAverage(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- nAvg:
int Number of iterations to use for averaging
- nAvg:
- Versions:
2014-11-23
@ddalle: Version 1.0
- get_nLastStats(comp=None)¶
Get the iteration at which to end statistics
- Call:
>>> nLast = opts.get_nLastStats() >>> nLast = opts.get_nLastStats(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of specific data book to query
- opts:
- Outputs:
- nLast:
int Maximum iteration to use for statistics
- nLast:
- Versions:
2015-03-04
@ddalle: Version 1.0
- get_nMaxStats(comp=None)¶
Get the maximum number of iterations to be used for statistics
- Call:
>>> nMax = opts.get_nMaxStats()
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of specific data book to query
- opts:
- Outputs:
- nMax:
int Maximum number of iterations to be used for statistics
- nMax:
- Versions:
2014-12-20
@ddalle: Version 1.0
- get_nMin(comp=None)¶
Get the minimum iteration number to consider for statistics
- Call:
>>> nMin = opts.get_nMin() >>> nMin = opts.get_nMin(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- opts:
- Outputs:
- nMin:
int Minimum iteration index to consider for statistics
- nMin:
- Versions:
2015-02-28
@ddalle: Version 1.0
- get_nPlotCols(comp=None)¶
Return the number of columns to use in plots
- Call:
>>> nCol = opts.get_nPlotCols() >>> nCol = opts.get_nPlotCols(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- nCol:
int Number of columns of plots
- nCol:
- Versions:
2014-11-23
@ddalle: Version 1.0
- get_nPlotFirst(comp=None)¶
Return the first iteration to plot in coefficient plots
- Call:
>>> nFirst = opts.get_nPlotFirst(comp)
- Inptus:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- nFirst:
int First iteration to plot for coefficient plots
- nFirst:
- Versions:
2015-03-04
@ddalle: Version 1.0
- get_nPlotIter(comp=None)¶
Return the number of iterations to plot for a component
If there are fewer than nPlot iterations in the current history, all iterations will be plotted.
- Call:
>>> nPlot = opts.get_nPlotIter(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- nPlot:
int Number of iterations to plot (maximum)
- nPlot:
- Versions:
2014-11-23
@ddalle: Version 1.0
- get_nPlotLast(comp=None)¶
Return the last iteration to plot
- Call:
>>> nLast = opts.get_nPlotLast(comp)
- Inptus:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- nLast:
int Last iteration to plot for coefficient plots
- nLast:
- Versions:
2015-03-04
@ddalle: Version 1.0
- get_nPlotRows(comp=None)¶
Return the number of rows to use in plots
- Call:
>>> nRow = opts.get_nPlotRows() >>> nRow = opts.get_nPlotRows(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
strorint Name of component to plot
- opts:
- Outputs:
- nRow:
int Number of rows of plots
- nRow:
- Versions:
2014-11-23
@ddalle: Version 1.0
- get_nStats(comp=None)¶
Get the number of iterations to be used for collecting statistics
- Call:
>>> nStats = opts.get_nStats() >>> nStats = opts.get_nStats(comp)
- Inputs:
- opts:
cape.options.Options Options interface
- comp:
str Name of specific data book component to query
- opts:
- Outputs:
- nStats:
int Number of iterations to be used for statistics
- nStats:
- Versions:
2014-12-20
@ddalle: Version 1.0
- get_umask(sys=True)¶
Get the current file permissions mask
The default value is the read from the system
- Call:
>>> umask = opts.get_umask(sys=True)
- Inputs:
- opts
cape.options.Options Options interface
- sys: {
True} |False Whether or not to use system setting as default
- opts
- Outputs:
- umask:
None|oct File permissions mask (
Noneonly if sys isFalse)
- umask:
- Versions:
2015-09-27
@ddalle: Version 1.0
- mkdir(fdir, sys=False)¶
Make a directory with the correct permissions
- Call:
>>> opts.mkdir(fdir, sys=False)
- Inputs:
- opts:
cape.options.Options Options interface
- fdir:
str Directory to create
- sys:
True| {False} Whether or not to replace
Nonewith system setting
- opts:
- Versions:
2015-09-27
@ddalle: Version 1.02017-09-05
@ddalle: Added sys input
- set_DataBookDir(fdir='data')¶
Set the folder that holds the data book
- Call:
>>> fdir = opts.get_DataBookDir()
- Inputs:
- opts:
cape.options.Options Options interface
- fdir:
str Relative path to data book folder
- opts:
- Versions:
2014-12-20
@ddalle: Version 1.0
- set_Delimiter(delim=',')¶
Set the delimiter to use in files
- Call:
>>> opts.set_Delimiter(delim)
- Inputs:
- opts:
cape.options.Options Options interface
- delim:
str Delimiter to use in data book files
- opts:
- Versions:
2014-12-21
@ddalle: Version 1.0
- set_PlotComponents(comps)¶
Set the list of components to plot
- Call:
>>> opts.set_PlotComponents(comps)
- Inputs:
- opts:
cape.options.Options Options interface
- comps:
list[str|int] List of components (names or numbers) to plot
- opts:
- Versions:
2014-11-22
@ddalle: Version 1.0
- set_SortKey(key)¶
Set the key to use for sorting the data book
- Call:
>>> opts.set_SortKey(key)
- Inputs:
- opts:
cape.options.Options Options interface
- key:
str|None|list[str] Name of key to sort with
- opts:
- Versions:
2014-12-30
@ddalle: Version 1.0
- set_dnStats(dn)¶
Set the increment in window sizes
- Call:
>>> opts.set_dnStats(dn)
- Inputs:
- opts:
cape.options.Options Options interface
- dn:
int Increment in candidate window sizes
- opts:
- Versions:
2017-09-29
@ddalle: Version 1.0
- set_nLastStats(nLast=None)¶
Get the iteration at which to end statistics
- Call:
>>> opts.get_nLastStats(nLast)
- Inputs:
- opts:
cape.options.Options Options interface
- nLast:
int Maximum iteration to use for statistics
- opts:
- Versions:
2015-03-04
@ddalle: Version 1.0
- set_nMaxStats(nMax=0)¶
Set the maximum number of iterations to be used for statistics
- Call:
>>> opts.set_nMaxStats(nMax)
- Inputs:
- opts:
cape.options.Options Options interface
- nMax:
int Number of iterations to be used for statistics
- opts:
- Versions:
2014-12-20
@ddalle: Version 1.0
- set_nMin(nMin=0)¶
Set the minimum iteration number to consider for statistics
- Call:
>>> opts.set_nMin(nMin)
- Inputs:
- opts:
cape.options.Options Options interface
- nMin:
int Minimum iteration index to consider for statistics
- opts:
- Versions:
2015-02-28
@ddalle: Version 1.0
- set_nStats(nStats=0)¶
Set the number of iterations to be used for collecting statistics
- Call:
>>> opts.set_nStats(nStats)
- Inputs:
- opts:
cape.options.Options Options interface
- nStats:
int Number of iterations to be used for statistics
- opts:
- Versions:
2014-12-20
@ddalle: Version 1.0
- class cape.cfdx.options.DataBook.DBTarget¶
Dictionary-based interface for data book targets
- Call:
>>> opts = DBTarget(**kw)
- Inputs:
- kw:
dict Dictionary of PBS options
- kw:
- Outputs:
- opts:
cape.options.DataBook.DBTarget Data book target options interface
- opts:
- Versions:
2014-12-01
@ddalle: Version 1.0
- get_CommentChar()¶
Get the character to used to mark comments
- Call:
>>> comchar = opts.get_CommentChar()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- comchar:
str Comment character (may be multiple characters)
- comchar:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_Delimiter()¶
Get the delimiter for a target file
- Call:
>>> delim = opts.get_Delimiter()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- delim:
str Delimiter text
- delim:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_RunMatrix()¶
Get the trajectory translations
- Call:
>>> traj = opts.get_RunMatrix()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- comchar:
str Comment character (may be multiple characters)
- comchar:
- Versions:
2014-12-21
@ddalle: Version 1.0
- get_TargetComponents()¶
Get the list of components described by this component
Returning
Noneis a flag to use all components from the data book.- Call:
>>> comps = opts.get_TargetComponents()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- comps:
list[str] List of components (
Noneif not specified)
- comps:
- Versions:
2015-06-03
@ddalle: Version 1.0
- get_TargetDir()¶
Get the directory for the duplicate target data book
- Call:
>>> fdir = opts.get_TargetDir()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- fdir:
str Name of the directory (relative to root directory)
- fdir:
- Versions:
2016-06-27
@ddalle: Version 1.0
- get_TargetFile()¶
Get the file name for the target
- Call:
>>> fname = opts.get_TargetFile()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- fname:
str Name of the file
- fname:
- Versions:
2014-12-20
@ddalle: Version 1.0
- get_TargetLabel()¶
Get the name/identifier for a given data book target
- Call:
>>> lbl = opts.get_TargetLabel()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- lbl:
str Label for the data book target to be used in plots and reports
- lbl:
- Versions:
2015-06-04
@ddalle: Version 1.0
- get_TargetName()¶
Get the name/identifier for a given data book target
- Call:
>>> Name = opts.get_TargetName()
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- opts:
- Outputs:
- Name:
str Identifier for the target
- Name:
- Versions:
2014-08-03
@ddalle: Version 1.0
- get_TargetType()¶
Get the target type for a target data book
- Call:
>>> typ = opts.get_TargetType()
- Inputs:
- opts:
cape.otpions.DataBook.DBTarget Options interface
- opts:
- Outputs:
- typ: {
"generic"} |"cape" Target type, generic CSV file or duplicate data book
- typ: {
- Versions:
2016-06-27
@ddalle: Version 1.0
- get_Tol(xk)¶
Get the tolerance for a particular trajectory key
- Call:
>>> tol = opts.get_Tol(xk)
- Inputs:
- opts:
cape.options.DataBook.DBTarget Options interface
- xk:
str Name of trajectory key
- opts:
- Outputs:
- tol:
float Tolerance to consider as matching value for a trajectory key
- tol:
- Versions:
2015-12-16
@ddalle: Version 1.0
