cape.pycart.databook: pyCart data book module¶
Databook module for cape.pycart
This module contains functions for reading and processing forces, moments, and other statistics from cases in a trajectory.
# Read Cart3D control instance cntl = cape.pycart.cntl.Cntl("pyCart.json") # Read the data book cntl.ReadDataBook() # Get a handle db = cntl.DataBook
Data book modules are also invoked during update and reporting command-line calls.
$ pycart --aero $ pycart --ll $ pycart --report
- class cape.pycart.databook.CaseFM(comp: str, **kw)¶
Cart3D iterative force & moment class
This class contains methods for reading data about an the history of an individual component for a single casecntl. It reads the file
{comp}.datwhere comp is the name of the component. From this file it determines which coefficients are recorded automatically. If some of the comment lines from the Cart3D output file have been deleted, it guesses at the column definitions based on the number of columns.- Call:
>>> fm = CaseFM(comp)
- Inputs:
- comp:
str Name of component to process
- comp:
- Outputs:
- fm:
cape.pycart.databook.CaseFM Instance of the force and moment class
- fm.coeffs:
list[str] List of coefficients
- fm:
- class cape.pycart.databook.CaseResid(meta: bool = False, **kw)¶
Iterative history class
This class provides an interface to residuals, CPU time, and similar data for a given run directory
- Call:
>>> hist = CaseResid()
- Outputs:
- hist:
cape.pycart.databook.CaseResid Instance of the run history class
- hist:
