avl_cli

Contents

avl_cli#

avl-aero-tables CLI entry point. Argument parsing and command dispatch only; schema validation and config loading live in avl_config. Provides verify, sweep, and plot subcommands driven by a YAML project file.

For usage examples see Quickstart.

API#

avl-aero-tables CLI entry point.

avl_aero_tables.avl_cli.main(argv=None)[source]#

Entry point for the avl-aero-tables CLI.

Global flags:

--help

Show a help message and exit (also works on every subcommand).

--version

Print the installed package version and exit.

Subcommands:

verify

Check that the AVL binary is installed and runnable.

sweep <yml>

Load a YAML project file and run the AVL sweep.

plot geometry <yml>

Four-view geometry plot from the .avl file.

plot totals [--beta-ref DEG] <runs_dir>

3-D total-coefficient surfaces (CLtot, CDtot, …) from sweep results. Pass a specific timestamped run directory, or a parent directory to use the latest run. --beta-ref slices control-surface plots at the nearest available sideslip angle (default 0°).

plot stab-deriv <runs_dir>

3-D stability-derivative surfaces (CLa, CLb, CLp, …, Cnr) — one figure per perturbation variable (α, β, p’, q’, r’).

plot ctrl-deriv <runs_dir>

3-D control-derivative surfaces (CLd01, CYd01, …) — one figure per control surface.

plot all [--beta-ref DEG] <runs_dir>

Generate all plots (totals, stab-deriv, ctrl-deriv) in one shot.

Example

avl-aero-tables --help
avl-aero-tables --version
avl-aero-tables verify
avl-aero-tables sweep examples/bd/bd.yml
avl-aero-tables plot geometry examples/bd/bd.yml
avl-aero-tables plot totals _runs/bd/
avl-aero-tables plot totals --beta-ref 5 _runs/bd/
avl-aero-tables plot stab-deriv _runs/bd/
avl-aero-tables plot ctrl-deriv _runs/bd/
avl-aero-tables plot all _runs/bd/
avl-aero-tables plot all --beta-ref 5 _runs/bd/
Parameters:

argv (list[str] | None)

Return type:

int