Command line interface

FramAT provides a command line tool which can be used to start a VLM analysis. The executable is called framat. If you simply run framat in a terminal without any arguments, a simple help page will be printed.

usage: framat [-h] {run,example} ...

positional arguments:
  {run,example}  execution modes
    run          run a FEM analysis
    example      create an example file

optional arguments:
  -h, --help     show this help message and exit

FramAT has different operating modes, namely run and example (in the help page referred to as positional arguments). To get more detailed help about these operating modes, type framat run -h or framat example -h.

Operating mode ‘example’

The mode example can be used to create a minimalistic working example. A JSON analysis file is created. Section Getting started demonstrates how to use this option.

Additional arguments

  • -o or --output Name of the output file (standard name is framat_beam.json).
  • -f or --force By default, FramAT will not overwrite any existing files. Using the force argument, existing files will be overwritten.

Operating mode ‘run’

The mode run is used read a JSON analysis file and to perform a FEM analysis. The JSON file name is required as the second positional argument. To evaluate an analysis defined in framat_beam.json, you can run:

framat run framat_beam.json

Additional arguments

  • -c, --clean Remove the results directory from a previous analysis.
  • --clean-only Remove the results directory from a previous analysis and exit.
  • -v, --verbose Verbose mode (print execution progress information).
  • -d, --debug Debug mode (print additional, detailed information).
  • -q, --quiet Print nothing (except errors).
  • --no-schema-check (Developer option) Skip a JSON schema validation.
  • --no-plots (Developer option) Do not create any plots.