7.2. pyfun: Python interface for FUN3D

This function provides a master interface for pyFun. All of the functionality from this script is also accessible from the cape.pyfun module using relatively simple commands.

Usage:

$ pyfun [OPTIONS]

Examples:

The basic call submits all (up to 10) jobs prescribed in the file pyFun.json

$ pyfun

This command uses the inputs from poweron.json and only displays statuses. No jobs are submitted.

$ pyfun -f poweron.json -c

This command submits at most 5 jobs, but only cases with “Mach” greater than 1.5 and “alpha” equal to 0.0 are considered as candidates.

$ pyfun -n 5 --cons "Mach>0.5, alpha==0.0"

Options:

-h, --help

Display this help message and quit

-c

Check status and don’t submit new jobs

-j

Show the PBS job numbers as well

-f FJSON

Use pyfun input file FJSON (default: "pyFun.json")

-x FPY

Executes Python script FPY using execfile() prior to taking other actions; can be stacked using -x FPY1 -x FPY2 -x FPY3, etc.

-n NJOB

Submit at most NJOB PBS scripts (default: 10)

--kill, --qdel

Remove jobs from the queue and stop them abruptly

--cons CNS

Only consider cases that pass a list of inequalities separated by commas. Constraints must use variable names (not abbreviations) from the trajectory described in FJSON.

-I INDS

Specify a list of cases to consider directly by index

--re REGEX

Restrict to cases whose name matches regular expression REGEX

--filter TXT

Restrict to cases whose name contains the exact text TXT

--glob TXT

Restrict to cases whose name matches the glob TXT

--unmarked

Find only cases that are not marked PASS or ERROR

--report RP

Update report named RP (default: first report in JSON file)

–report RP –force

Update report and ignore cache for all subfigures

–report RP –no-compile

Create images for a report but don’t compile into PDF

–report RP –rm

Delete existing caches of report subfigure images instead of creating them

--dezombie

Clean up ZOMBIE cases, which appear to be RUNNING but have no recently modified files

--exec, -e CMD

Execute command CMD in each folder

--aero, --fm, --fm GLOB

Loop through cases and extract force and moment coefficients and statistics for force & moment components described in the “DataBook” section of FJSON; only process components whose names wildcard GLOB if used

--ll, --ll GLOB

Loop through cases and extract force and moment coefficients and statistics for LineLoad components described in the “DataBook” section of FJSON; only process components whose names match wildcard GLOB if used

--triqfm, --triqfm GLOB

Loop through cases and extract force and moment coefficients and statistics for TriqFM components described in the “DataBook” section of FJSON; only process components whose names match wildcard GLOB if used

--PASS

Mark cases with “p” in run matrix to denote completion

--ERROR

Mark cases with “E” in run matrix to denote that they cannot run

--unmark

Remove PASS or ERROR markings from selected cases

--clean

Delete any files as described by ProgressDeleteFiles in “Archive” section of FJSON; can be run at any time

--archive

Create archive according to options in “Archive” section of FJSON and clean up run folder if case is marked PASS

--skeleton

Do --archive actions and also delete even more files according to FJSON settings like SkeletonDeleteFiles

--rm

Delete a cases folder [--no-prompt w/o interactive prompt]

--apply

Apply the settings in FJSON to all cases; way to quickly change settings for one or more runs

--extend, --extend E

Add another run of the current last phase E times (default: 1)

--imax M

Do not extend a case (when using –extend) beyond iteration M

--no-start

When running a command that would otherwise submit jobs, set them up but do not start (or submit) them

--no-restart

When submitting new jobs, only submit new cases (status ‘—‘)

-q QUEUE

Submit to a specific queue, overrides value in JSON file

Versions:

• 2014-10-06 @ddalle: Version 1.0 (of pycart)

• 2015-10-16 @ddalle: Version 1.0

• 2020-09-11 @ddalle: Version 1.1

• 2021-03-04 @ddalle: Version 1.2; use “entry_points”