3. Usage and Common Settings

This section covers basic usage of the CAPE modules that work for each solvers. That is, there is no need for separate descriptions for Cart3D, OVERFLOW, and FUN3D.

The most important cape tools are the command-line scripts pycart, pyfun, and pyover. These are used to submit jobs, check status, and perform post-processing. Each of the three has an extensive set of command-line options, and most of these are available to all three scripts. Each executable script has at a minimum a JSON file as an input.

Note

For CAPE developers, the three scripts (and other CAPE executables) are all located in the $CAPE/bin/ folder. For regular users who install cape using pip as recommended in these docs, the executables will live alongside the other local executables installed by pip.

On a Linux system, this will often be $HOME/.local/bin.

In addition, all the functionality of the pycart, pyfun, and pyover scripts can be accessed via a Python API. Each of the three scripts has its own module: cape.pycart.cntl, cape.pyfun.cntl, or cape.pyover.cntl. These are typically more useful for accessing post-processing data, and it can also be useful in creating advanced scenarios that cannot be set up fully within the JSON input file.

Finally, there a number of additional executables that serve more specific purposes such as converting file formats.

• 3.1. General Case Setup
  • 3.1.1. Matrix Setup
  • 3.1.2. Pre-run JSON Setup
  • 3.1.3. Mesh Files and Other Templates
  • 3.1.4. Data Book Setup
  • 3.1.5. Case Disposition and Archiving
• 3.2. Command-Line Interface
  • 3.2.1. Basic Commands
    • 3.2.1.1. Help Message
    • 3.2.1.2. Status Check
    • 3.2.1.3. Batch Commands
    • 3.2.1.4. Data Book Updates
    • 3.2.1.5. Archiving Solutions
    • 3.2.1.6. Trimming Excess Files While Running
    • 3.2.1.7. Creating Reports
    • 3.2.1.8. Killing Jobs
    • 3.2.1.9. Removing Cases
    • 3.2.1.10. Execute a Script in Each Case Folder
    • 3.2.1.11. Extending a Case to Repeat the Last Phase
    • 3.2.1.12. Apply New Settings and/or Add Phases
    • 3.2.1.13. Submitting or Running Jobs
  • 3.2.2. Command Modifiers
  • 3.2.3. Run Matrix Subsetting
    • 3.2.3.1. Specific Indices
    • 3.2.3.2. Using Constraints
    • 3.2.3.3. Filtering by Folder Name
    • 3.2.3.4. Filtering by File Glob
    • 3.2.3.5. Using Regular Expressions
• 3.3. Syntax for CAPE JSON Files
• 3.4. Syntax for Run Matrix Files
• 3.5. Setting Freestream Conditions in Cape
  • 3.5.1. Angle of Attack and Sideslip
  • 3.5.2. Freestream State
• 3.6. Automated Post-Processing Reports
  • 3.6.1. Report Definitions
  • 3.6.2. Sweep Definitions
  • 3.6.3. Figure Definitions
  • 3.6.4. Subfigure Definitions
  • 3.6.5. Automated Tecplot Figures
    • 3.6.5.1. Setting Layout Variables
    • 3.6.5.2. Altering Contour Level Maps
    • 3.6.5.3. Altering Color Maps
    • 3.6.5.4. Changing the FIELDMAP Parameter
    • 3.6.5.5. Altering Other Layout Parameters
• 3.7. Common JSON Settings
  • 3.7.1. Uncategorized JSON Options
    • 3.7.1.1. Maximum Number of Jobs to Submit
    • 3.7.1.2. File Permissions Mask
    • 3.7.1.3. Startup Shell Commands
    • 3.7.1.4. Special Python Modules
    • 3.7.1.5. Miscellaneous Options Dictionary
  • 3.7.2. PBS Script Options
    • 3.7.2.1. Introduction
    • 3.7.2.2. PBS Option Dictionary
  • 3.7.3. SLURM Script Options
    • 3.7.3.1. Introduction
    • 3.7.3.2. SLURM Option Dictionary
  • 3.7.4. Run Control Settings
    • 3.7.4.1. Phase Control Options
    • 3.7.4.2. Job Type Options
    • 3.7.4.3. Environment Variables
    • 3.7.4.4. System Resources
    • 3.7.4.5. Surface Triangulation Intersection
  • 3.7.5. Archive Settings
    • 3.7.5.1. Basic Archive Definitions
    • 3.7.5.2. File Glob Inputs
    • 3.7.5.3. Pre-Archive File Inputs
    • 3.7.5.4. In-Progress File Archiving Inputs
    • 3.7.5.5. Post-Archive File Inputs
  • 3.7.6. Solution Configuration & Component Names
  • 3.7.7. Data Book Definitions
    • 3.7.7.1. General Data Book Definitions
    • 3.7.7.2. Data Book Component Definitions
    • 3.7.7.3. Target or Comparison Data Sources
  • 3.7.8. Automated Report Generation with LaTeX
    • 3.7.8.1. Report Definitions
    • 3.7.8.2. Sweep Definitions
    • 3.7.8.3. Figure Definitions
    • 3.7.8.4. Subfigure Definitions
  • 3.7.9. RunMatrix or Run Matrix
    • 3.7.9.1. Example Trajectories
    • 3.7.9.2. RunMatrix Option Dictionary
    • 3.7.9.3. List of Built-In Variables
• 3.8. Advanced Setup: Python Scripting
  • 3.8.1. Using Scripts to Modify or Add Settings
  • 3.8.2. Global Settings from Python Modules
  • 3.8.3. Special Settings for Individual Runs from Python Modules