OpenMDAO
Standardize CLI argument names
Desired capability or behavior.
Currently the various utilities were written at different times by different people, resulting in slightly different arguments for each command. For example, sometimes specifying a legacy code is done with -l, but in other places it is -f.
Commands should be standardized across Aviary, with identical naming scheme for similar concepts, as well as ensuring things like which arguments are positional are also standardized (meaning standardizing things like aviary command input_filename -o options vs. aviary command -f input_filename -o options)
Is your feature request related to a problem? Please describe.
No response
Associated Bug Report
No response
This change will affect doc building. Hopefully, glue feature can help but still we need to manually update the docs.
Current arguments
usage: aviary [-h] [--version] ...
aviary Command Line Tools
optional arguments:
-h, --help show this help message and exit
--version show version and exit
Tools:
convert_aero_table
Converts FLOPS- or GASP-formatted aero data files into Aviary csv format.
convert_engine Converts FLOPS- or GASP-formatted engine decks into
Aviary csv format. FLOPS decks are changed from column-
delimited to csv format with added headers. GASP decks
are reorganized into column based csv. T4 is recovered
through calculation. Data points whose T4 exceeds T4max
are removed.
convert_prop_table
Converts GASP-formatted propeller map file into Aviary
csv format.
dashboard Run the Dashboard tool
draw_mission Allows users to draw a mission profile for use in
Aviary.
fortran_to_aviary
Converts legacy Fortran input decks to Aviary csv based
decks
hangar Allows users that pip installed Aviary to download
models from the Aviary hangar
plot_drag_polar Plot a Drag Polar Graph using a provided polar data csv
input
run_mission Runs Aviary using a provided input deck
usage: aviary run_mission [-h] [--optimizer {SNOPT,IPOPT,SLSQP,None}] [--phase_info PHASE_INFO] [--max_iter MAX_ITER] [--shooting] [--verbosity {0,1,2,3}] indeck
positional arguments:
indeck Name of vehicle input deck file
optional arguments:
-h, --help show this help message and exit
--optimizer {SNOPT,IPOPT,SLSQP,None}
Name of optimizer
--phase_info PHASE_INFO
Path to phase info file
--max_iter MAX_ITER maximum number of iterations
--shooting Use shooting instead of collocation
--verbosity {0,1,2,3}
verbosity settings: 0=quiet, 1=brief, 2=verbose,
3=debug
usage: aviary fortran_to_aviary [-h] [-o OUT_FILE] -l {GASP,FLOPS} [--force] [-v {0,1,2,3}] input_deck
positional arguments:
input_deck Filename of vehicle input deck, including partial or
complete path.
optional arguments:
-h, --help show this help message and exit
-o OUT_FILE, --out_file OUT_FILE
Filename for converted input deck, including partial
or complete path.
-l {GASP,FLOPS}, --legacy_code {GASP,FLOPS}
Name of the legacy code the deck originated from
--force Allow overwriting existing output files
-v {0,1,2,3}, --verbosity {0,1,2,3}
Set level of print statements
usage: aviary hangar [-h] [-o OUTDIR] [-v] indecks [indecks ...]
positional arguments:
indecks Name of file or folder to download from Aviary/models
optional arguments:
-h, --help show this help message and exit
-o OUTDIR, --outdir OUTDIR
Directory to write outputs. Defaults to aviary_models
in the current directory.
-v, --verbose Enable verbose outputs
usage: aviary convert_engine [-h] [-f {FLOPS,GASP,GASP_TS}] input_file [output_file]
positional arguments:
input_file path to engine deck file to be converted
output_file path to file where new converted data will be written
optional arguments:
-h, --help show this help message and exit
-f {FLOPS,GASP,GASP_TS}, --data_format {FLOPS,GASP,GASP_TS}
data format used by input_file
usage: aviary convert_aero_table [-h] [-f {FLOPS,GASP}] input_file [output_file]
positional arguments:
input_file path to aero data file to be converted
output_file path to file where new converted data will be written
optional arguments:
-h, --help show this help message and exit
-f {FLOPS,GASP}, --data_format {FLOPS,GASP}
data format used by input_file
usage: aviary convert_prop_table [-h] [-f [{GASP}]] input_file [output_file]
positional arguments:
input_file path to propeller map file to be converted
output_file path to file where new converted data will be written
optional arguments:
-h, --help show this help message and exit
-f [{GASP}], --data_format [{GASP}]
data format used by input_file
usage: aviary plot_drag_polar [-h]
optional arguments:
-h, --help show this help message and exit
usage: aviary dashboard [-h] [--problem_recorder PROBLEM_RECORDER] [--driver_recorder DRIVER_RECORDER] [--port PORT] [-b] [-d] [--save [SAVE]] [--force] [script_name ...]
positional arguments:
script_name Name of aviary script that was run (not including.py).
optional arguments:
-h, --help show this help message and exit
--problem_recorder PROBLEM_RECORDER
Problem case recorder file name
--driver_recorder DRIVER_RECORDER
Driver case recorder file name. Set to None if file is ignored
--port PORT dashboard server port ID (default is 0, which
indicates get any free port)
-b, --background Run the server in the background (don't automatically
open the browser)
-d, --debug show debugging output
--save [SAVE] Name of zip file in which dashboard files are saved.
If no argument given, use the script name to name the zip file
--force When displaying data from a shared zip file, if the
directory in the reports directory exists, overrite if this is True
usage: aviary hangar [-h] [-o OUTDIR] [-v] indecks [indecks ...]
positional arguments:
indecks Name of file or folder to download from Aviary/models
optional arguments:
-h, --help show this help message and exit
-o OUTDIR, --outdir OUTDIR
Directory to write outputs. Defaults to aviary_models
in the current directory.
-v, --verbose Enable verbose outputs