Quick Start

Note

In this documentation, IVABS_ROOT refers to the root directory of iVABS after installation.

Run iVABS with a simple example

Start the shell/terminal that is configured during the installation. Please refer to Download & Installation for more information.

If you are using Python virtual environment managed by Anaconda (see /install/python_setup), you need to activate it first. For example, if Python 3.6 and all dependencies are installed in a virtual environment named py3ivabs, then activate it using

conda activate py3ivabs

Go to the directory IVABS_ROOT/examples/anl_cs_airfoil_box

cd IVABS_ROOT/examples/anl_cs_airfoil_box

Run the example using the following command.

ivabs main.yml --mode 1

If iVABS has been installed properly, a single cross-sectional analysis will be carried out and the result can be found in the output file main.out.

iVABS command line interface

Type ivabs -h to see the list of arguments and options.

usage: ivabs [-h] [--loglevelcmd {debug,info,warning,error,critical}]
             [--loglevelfile {debug,info,warning,error,critical}] [--logfile LOGFILE]
             {analyze,iter,map,plot} ...

iVABS

positional arguments:
  {analyze,iter,map,plot}
                        sub-command help
    analyze             Analyze a design
    iter                Iterative analysis
    map                 Create a mapping of meshes between the physcial and parametric domains
    plot                Plot all CS/SG

options:
  -h, --help            show this help message and exit
  --loglevelcmd {debug,info,warning,error,critical}
                        Command line logging level
  --loglevelfile {debug,info,warning,error,critical}
                        File logging level
  --logfile LOGFILE     Logging file name

Single analysis

ivabs analyze <main_input_file> [options]

Iterative analysis

ivabs iter <main_input_file> [options]

Other examples

More examples can be found in Section Examples.