CAPE Executables

The following lists the CAPE executables, which are the main interface to CAPE directly from the system command line.

• cape: Control run matrix or case for any solver
  • cape help: Display help message and exit
  • cape run: Run case in current folder
  • cape start: Setup, start, and/or submit cases
  • cape check: Check status of one or more cases
  • cape agent: Run one CAPE agent prompt and exit
  • cape agentic: Run CAPE in agentic mode
  • cape 1to2: Convert Python and JSON files from CAPE 1 to 2 standard
  • cape apply: Re-apply current settings to case(s)
  • cape approve: Mark selected cases as complete
  • cape archive: Archive cases; delete files not needed for post-processing
  • cape batch: Submit CAPE command as a PBS/Slurm batch job
  • cape check-db: Check completion of all databook components
  • cape check-fm: Check completion of all force & moment components
  • cape check-ll: Check completion of all line load components
  • cape check-triqfm: Check completion of TriqFM components
  • cape clean: Remove extra files not necessary for running a case
  • cape collect-cutplane: Collect cut-plane data in current case folder
  • cape collect-surf: Collect surface data in current case folder
  • cape defail: Remove FAIL files from case(s)and other failure artifacts
  • cape dezombie: Delete job and clean-up stalled cases (aka ‘zombie’ cases)
  • cape dispatch: Interactively dispatch case(s) by status only
  • cape edit-json: Edit JSON settings from command-line
  • cape exec: Run a shell command in folder of case(s)
  • cape extend: Extend unmarked cases
  • cape extract: Extract DataBook components
  • cape extract-fm: Extract averaged force & moment results
  • cape extract-iter-fm: Extract iterative force & moment histories
  • cape extract-ll: Compute and extract line load results
  • cape extract-pyfunc: Extract data from custom Python functions
  • cape extract-prop: Extract other scalar results
  • cape extract-surfcp: Extract surfcp data
  • cape extract-timeseries: Extract time series data
  • cape extract-triqfm: Extract post-processed patch loads
  • cape extract-triqpt: Collect post-processed point sensor data
  • cape fail: Mark selected cases as ERRORs
  • cape find: Find indices of cases meeting constraints
  • cape find-cases: Find indices of cases meeting constraints
  • cape find-json: Find CAPE JSON files
  • cape find-large: Find folders with large file size
  • cape get-col-state: Show iterative state of one column for case(s)
  • cape get-config: Show value of user CAPE configuration
  • cape get-keys: Show properties of run matrix keys as JSON
  • cape get-subfig: Create one report subfigure and cache its image
  • cape help-opt: Show help and docs for JSON options
  • cape inspect-json: Show item or subset of JSON options
  • cape list-keys: List run matrix keys
  • cape list-subfigs: List report subfigures
  • cape open-pdf: Open a PDF file in preferred reader
  • cape open-img: Open an image file in preferred viewer
  • cape open-png: Open a PNG image in preferred viewer
  • cape open-subfig: Create one report subfigure and open its image
  • cape perform: Perform an Actions action on case(s)
  • cape post-file: Send one or more files to RemoteHost
  • cape qdel: Delete PBS/Slurm job of case(s)
  • cape receive-file: Receive posted file from remote host
  • cape report: Update automated PDF reports
  • cape review: Interactively review report subfigures for case(s)
  • cape rm: Delete entire case folders
  • cape search-large: Find large cases from all run matrices in repo
  • cape set-config: Set value of a user CAPE configuration
  • cape get-case-state: Show iterative state of report columns for case(s)
  • cape skeleton: Clean up case folder; leave only key files
  • cape triangulate-cutplane: Triangulate oversetting cut-plane flow viz files
  • cape tui: Run rich interactive CAPE terminal user interface
  • cape ui: Run interactive CAPE user interface
  • cape unarchive: Expand files from archive
  • cape unmark: Remove PASS/ERROR markings for selected cases
• pycart: Interact with Cart3D run matrix using CAPE
• pyfun: Interact with FUN3D run matrix using CAPE
• pykes: Interact with Kestrel run matrix using CAPE
• pyover: Interact with OVERFLOW run matrix using CAPE
• dkit: Command-line interface to datakit tools
• dkit-quickstart: Create template for a new datakit package
• dkit-vendorize: Vendorize one or more packages
• dkit-writedb: Read raw data to create formatted datakit files
• run_flowCart.py: Run Cart3D for one phase
• run_fun3d.py: Run FUN3D for one phase
• run_overflow.py: Run OVERFLOW for one phase
• cape-writell: Combine CAPE line load data into MAT file
• cape-step2crv: Convert STEP file to Plot3D multiple curve file
• cape-steptri2crv: Extract TRI file nodes on STEP curves
• cape-uh3d2tri: Convert UH3D triangulation to Cart3D format
• cape-tec: Export image from Tecplot(R) layout file
• cape-tri2plt: Convert Triangulation to Tecplot PLT Format
• cape-tri2uh3d: Convert Cart3D Triangulation to UH3D Format
• cape-tri2surf: Convert surf triangulation to AFLR3 format
• cape-expandjson: Expand a JSON file and remove comments
• pyfun-plt2triq: Convert FUN3D Tecplot file to Cart3D tri file
• triqfm: Calculate forces and moments on a .triq file