Command Line Tools

Command Line Tools#

Aviary has a number of command line tools that are available via the aviary command.

Note

When using a command line tool on a script that takes its own command line arguments, those arguments must be placed after a -- on the command line. Anything to the right of the -- will be ignored by the Aviary command line parser and passed on to the user script. For example: Aviary sub_command -o foo.html myscript.py -- -x --myarg=bar would pass -x and --myarg=bar as args to myscript.py.

All available aviary sub-commands can be shown using the following command:

aviary -h

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

usage: aviary [-h] [--version]  ...

aviary Command Line Tools

options:
  -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

To get further info on any sub-command, follow the command with a -h. For example:

aviary run_mission -h

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

usage: aviary run_mission [-h] [-o OUTDIR]
                          [--optimizer {SNOPT,IPOPT,SLSQP,None}]
                          [--phase_info PHASE_INFO] [--n2]
                          [--max_iter MAX_ITER] [--shooting]
                          indeck

positional arguments:
  indeck                Name of vehicle input deck file

options:
  -h, --help            show this help message and exit
  -o OUTDIR, --outdir OUTDIR
                        Directory to write outputs
  --optimizer {SNOPT,IPOPT,SLSQP,None}
                        Name of optimizer
  --phase_info PHASE_INFO
                        Path to phase info file
  --n2                  Generate an n2 diagram after the analysis
  --max_iter MAX_ITER   maximum number of iterations
  --shooting            Use shooting instead of collocation

Available Commands and Their Usage#

aviary run_mission#

run_mission is a command line interface that will run an analysis on a given csv input file.

To use small_single_aisle_GwGm.csv run the command aviary run_mission models/small_single_aisle/small_single_aisle_GwGm.csv

SNOPT is the default optimizer, but IPOPT is available as well.

aviary run_mission -h

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

usage: aviary run_mission [-h] [-o OUTDIR]
                          [--optimizer {SNOPT,IPOPT,SLSQP,None}]
                          [--phase_info PHASE_INFO] [--n2]
                          [--max_iter MAX_ITER] [--shooting]
                          indeck

positional arguments:
  indeck                Name of vehicle input deck file

options:
  -h, --help            show this help message and exit
  -o OUTDIR, --outdir OUTDIR
                        Directory to write outputs
  --optimizer {SNOPT,IPOPT,SLSQP,None}
                        Name of optimizer
  --phase_info PHASE_INFO
                        Path to phase info file
  --n2                  Generate an n2 diagram after the analysis
  --max_iter MAX_ITER   maximum number of iterations
  --shooting            Use shooting instead of collocation

aviary fortran_to_aviary#

The aviary fortran_to_aviary command will convert a Fortran input deck to an Aviary csv.

The only required input is the filepath to the input deck. Optionally, a deck of default values can be specified, this is useful if an input deck assumes certain values for any unspecified variables. If an invalid filepath is given, pre-packaged resources will be checked for input decks with a matching name.

Notes for input decks:

FLOPS, GASP, or Aviary names can be used for variables (Ex WG or Mission:Design:GROSS_MASS)
When specifying variables from FORTRAN, they should be in the appropriate NAMELIST.
Aviary variable names should be specified outside any NAMELISTS.
Names are not case-sensitive.
Units can be specified using any of the openMDAO valid units.
Comments can be added using !
Lists can be entered by separating values with commas.
Individual list elements can be specified by adding an index after the variable name.
(NOTE: 1 indexing is used inside NAMELISTS, while 0 indexing is used outside NAMELISTS)

Example inputs:

aircraft:fuselage:pressure_differential = .5, atm !DELP in GASP, but using atmospheres instead of psi
ARNGE(1) = 3600 !target range in nautical miles
pyc_phases = taxi, groundroll, rotation, landing

aviary fortran_to_aviary -h

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

usage: aviary fortran_to_aviary [-h] [-o OUT_FILE] -l {FLOPS,GASP}
                                [-d DEFAULTS_DECK] [--force] [-v {0,1,2,3}]
                                input_deck

positional arguments:
  input_deck            Filename of vehicle input deck, including partial or
                        complete path.

options:
  -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 {FLOPS,GASP}, --legacy_code {FLOPS,GASP}
                        Name of the legacy code the deck originated from
  -d DEFAULTS_DECK, --defaults_deck DEFAULTS_DECK
                        Deck of default values for unspecified variables
  --force               Allow overwriting existing output files
  -v {0,1,2,3}, --verbosity {0,1,2,3}
                        Set level of print statements

aviary hangar#

The aviary hangar command will copy files and folders from the Aviary hangar to an accessible directory. This is useful for users that have pip installed Aviary, but want to experiment with the included examples.

The only required input is the name of an input deck. This can be specified as the name of the file, the path from aviary/models, the name of a folder in aviary/models. Multiple files and folders can be copied at once. Optionally, the output directory can be specified; if it is not, the files will be copied into the current working directory in a folder called aviary_models. If specified, the output directory will be created as needed.

Example usage:

`aviary hangar engines` Copy all files in the engines folder
`aviary hangar turbofan_22k.txt` Copy the 22k turbofan deck
`aviary hangar N3CC/N3CC_data.py` Copy the N3CC data
`aviary hangar small_single_aisle_GwGm.dat small_single_aisle_GwGm.csv` Copy the Fortran and Aviary input decks for the small single aisle
`aviary hangar turbofan_22k.txt -o ~/example_files` Copy the engine model into ~/example_files

aviary hangar -h

sh: 0: getcwd() failed: No such file or directory

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

Traceback (most recent call last):
  File "/usr/share/miniconda/envs/test/bin/aviary", line 5, in <module>
    from aviary.interface.cmd_entry_points import aviary_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/interface/cmd_entry_points.py", line 11, in <module>
    from aviary.visualization.dashboard import _dashboard_setup_parser, _dashboard_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/visualization/dashboard.py", line 20, in <module>
    import hvplot.pandas  # noqa # need this ! Otherwise hvplot using DataFrames does not work
    ^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/hvplot/__init__.py", line 65, in <module>
    import panel as _pn
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/panel/__init__.py", line 48, in <module>
    from param import rx
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/__init__.py", line 14, in <module>
    from .parameters import (  # noqa: api import
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2602, in <module>
    class resolve_path(ParameterizedFunction):
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2619, in resolve_path
    search_paths = List(default=[os.getcwd()], pickle_default_value=False, doc="""
                                 ^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory

aviary convert_engine#

The aviary convert_engine command will convert a legacy formatted (FLOPS or GASP) engine deck into an Aviary formatted engine deck.

Users must provide the path or name of an input deck, the path to the output file, and the engine format being converted. If an invalid filepath is given for the input file, pre-packaged resources will be checked for input decks with a matching name.

Notes for input decks:

Turbofan decks for both FLOPS and GASP can be converted
Turboshaft decks for GASP can also be converted
Comments can be added using #

Example usage:

`aviary convert_engine turbofan_23k_1.eng turbofan_23k_1_lbm_s.deck -f GASP` Convert a GASP based turbofan
`aviary convert_engine -f FLOPS turbofan_22k.eng turbofan_22k.txt` Convert a FLOPS based turbofan
`aviary convert_engine turboshaft_4465hp.eng turboshaft_4465hp.deck --data_format GASP_TS` Convert a GASP based turboshaft

aviary convert_engine -h

sh: 0: getcwd() failed: No such file or directory

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

Traceback (most recent call last):
  File "/usr/share/miniconda/envs/test/bin/aviary", line 5, in <module>
    from aviary.interface.cmd_entry_points import aviary_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/interface/cmd_entry_points.py", line 11, in <module>
    from aviary.visualization.dashboard import _dashboard_setup_parser, _dashboard_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/visualization/dashboard.py", line 20, in <module>
    import hvplot.pandas  # noqa # need this ! Otherwise hvplot using DataFrames does not work
    ^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/hvplot/__init__.py", line 65, in <module>
    import panel as _pn
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/panel/__init__.py", line 48, in <module>
    from param import rx
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/__init__.py", line 14, in <module>
    from .parameters import (  # noqa: api import
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2602, in <module>
    class resolve_path(ParameterizedFunction):
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2619, in resolve_path
    search_paths = List(default=[os.getcwd()], pickle_default_value=False, doc="""
                                 ^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory

aviary convert_aero_table#

The aviary convert_aero_table command will convert a legacy formatted (FLOPS or GASP) aero table into an Aviary formatted aero table.

Users must provide the path or name of an input deck and the data format being converted. Optionally, the path to the output file can also be specified, otherwise the default output file will be in the same location and have the same name as input file, but with ‘_aviary’ appended to filename. If an invalid filepath is given for the input file, pre-packaged resources will be checked for input decks with a matching name.

Notes for input decks:

Aero tables for both FLOPS and GASP can be converted
GASP tables will create a single file containing all the lift and drag information
FLOPS tables will create two files, one containing the lift-dependent drag and the other containing the lift-independent drag.
Comments can be added using #

Example usage:

`aviary convert_aero_table -f GASP subsystems/aerodynamics/gasp_based/data/GASP_aero_free.txt large_single_aisle_1_aero_flaps.txt` Convert a GASP based aero table
`aviary convert_aero_table -f FLOPS utils/test/flops_test_polar.txt aviary_flops_polar.txt` Convert a FLOPS based aero table

aviary convert_aero_table -h

sh: 0: getcwd() failed: No such file or directory

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

Traceback (most recent call last):
  File "/usr/share/miniconda/envs/test/bin/aviary", line 5, in <module>
    from aviary.interface.cmd_entry_points import aviary_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/interface/cmd_entry_points.py", line 11, in <module>
    from aviary.visualization.dashboard import _dashboard_setup_parser, _dashboard_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/visualization/dashboard.py", line 20, in <module>
    import hvplot.pandas  # noqa # need this ! Otherwise hvplot using DataFrames does not work
    ^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/hvplot/__init__.py", line 65, in <module>
    import panel as _pn
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/panel/__init__.py", line 48, in <module>
    from param import rx
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/__init__.py", line 14, in <module>
    from .parameters import (  # noqa: api import
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2602, in <module>
    class resolve_path(ParameterizedFunction):
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2619, in resolve_path
    search_paths = List(default=[os.getcwd()], pickle_default_value=False, doc="""
                                 ^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory

aviary convert_prop_table#

The aviary convert_prop_table command will convert a legacy formatted (GASP) propeller map into an Aviary formatted propeller map.

Users must provide the path or name of an input deck, the path to the output file, and the engine format being converted. If an invalid filepath is given for the input file, pre-packaged resources will be checked for input decks with a matching name.

Notes for input decks:

There are two options for Mach number: Mach number and helical Mach number at 75% radius. We provide one example for each. This is the first integer on the first line of the input file. (1 = Mach, 2 = helical Mach)
Comments can be added using #

Example usage:

`aviary convert_prop_table -f GASP PropFan.map PropFan.prop` Convert a GASP based propeller map
`aviary convert_prop_table -f GASP general_aviation.map general_aviation.prop` Convert a GASP based propeller map

The first example uses Mach number and the second example uses helical Mach number. Note that the output file name can be skipped. Since there is only one input data format is supported at this time, input data format is defaulted to GASP if not provided.

aviary convert_prop_table -h

sh: 0: getcwd() failed: No such file or directory

/usr/share/miniconda/envs/test/lib/python3.12/site-packages/pyoptsparse/pyOpt_MPI.py:68: UserWarning: mpi4py could not be imported. mpi4py is required to use the parallel gradient analysis and parallel objective analysis for non-gradient based optimizers. Continuing using a dummy MPI module from pyOptSparse.
  warnings.warn(warn)

Traceback (most recent call last):
  File "/usr/share/miniconda/envs/test/bin/aviary", line 5, in <module>
    from aviary.interface.cmd_entry_points import aviary_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/interface/cmd_entry_points.py", line 11, in <module>
    from aviary.visualization.dashboard import _dashboard_setup_parser, _dashboard_cmd
  File "/home/runner/work/Aviary/Aviary/aviary/visualization/dashboard.py", line 20, in <module>
    import hvplot.pandas  # noqa # need this ! Otherwise hvplot using DataFrames does not work
    ^^^^^^^^^^^^^^^^^^^^
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/hvplot/__init__.py", line 65, in <module>
    import panel as _pn
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/panel/__init__.py", line 48, in <module>
    from param import rx
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/__init__.py", line 14, in <module>
    from .parameters import (  # noqa: api import
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2602, in <module>
    class resolve_path(ParameterizedFunction):
  File "/usr/share/miniconda/envs/test/lib/python3.12/site-packages/param/parameters.py", line 2619, in resolve_path
    search_paths = List(default=[os.getcwd()], pickle_default_value=False, doc="""
                                 ^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory

Command Line Tools

Contents

Command Line Tools#

Available Commands and Their Usage#

aviary run_mission#

aviary fortran_to_aviary#

aviary hangar#

aviary convert_engine#

aviary convert_aero_table#

aviary convert_prop_table#