Command Line Interface

Warning

The command line interface is based on the fire package since version 20**.5.0, and it is not compatible with the command line interface of previous versions.

The default execution procedure invoked by abqpy inside the Python interpreter environment where it is installed is to run one of the two following command lines:

1. When the abaqus module is imported for the first time:

   abaqus cae noGUI=script.py -- [args ...]
   

2. When the odbAccess module is imported for the first time:

   abaqus python script.py [args ...]
   

These commands lines are invoked when you run your script containing the above statements in your installed Python interpreter, with a simple command line launch:

python script.py [args ...]

However, there are other execution procedures that can be run with the abaqus command and also another options that could be passed to these commands. To supply that procedures and options, abqpy provides two alternatives. One of them is a separate command line interface (another alternative is to use an System Environment Variable).

Currently, abqpy command line interface provides several execution modes: Abaqus/CAE Execution mode and Abaqus Python Execution mode, and more:

abqpy COMMAND SCRIPT <flags> [ARGS]...

where COMMAND is one of abaqus, cae, python, run or any other Abaqus commands, SCRIPT is the file name of your python script, flags are the options that could be passed to the command, and ARGS are the extra arguments to be passed after the command line options. For details, see the References section or run abqpy COMMAND --help for help.

Note

For the following commands, the boolean flags can be specified with the following syntax (take gui as an example):

• --gui or --gui=True to set the flag to True;

• --nogui or --gui=False to set the flag to False.

See here for more detailed information.

Examples

1. If you want to run you python script in Abaqus/CAE mode, you could run:

   abqpy cae script.py [args ...]
   

2. If you want to run your python script in Abaqus/CAE GUI or noGUI mode, providing the database file option, you could run:

   abqpy cae script.py --gui --database=file.odb [args ...] # GUI mode
   
   abqpy cae script.py --nogui --database=file.odb [args ...] # noGUI mode
   

3. If you want to run your python script in Abaqus Python Execution mode, you could run:

   abqpy python script.py [args ...]
   

4. If you want to call the cli in your python script, you could use the abqpy.cli.abaqus object:

   from abqpy.cli import abaqus
   
   abaqus.cae("script.py", gui=True, database="file.odb")
   

Some modern Python IDEs allow you to customize the default python launch parameters that will be passed to the interpreter. This feature permits to run abqpy command line interface as a module script and customize your default abaqus execution procedure.

Example: In VS Code Python Extension, you can specify the following setting:

"python.terminal.launchArgs": [ "-m", "abqpy", "cae", "--gui=True" ]

That setting will make VS Code Python Extension run by default all python script files in the integrated terminal with the following command line:

python -m abqpy cae --gui=True script.py [args ...]

Which provides a way to change the default abaqus execution procedure to GUI mode.

Warning

Noted that if a token other than another flag immediately follows a flag that’s supposed to be a boolean, the flag will take on the value of the token rather than the boolean value. Thus --gui=True instead of --gui is used here to prevent this problem.

References

$ abqpy
NAME
    abqpy - The abqpy command line interface.

SYNOPSIS
    abqpy GROUP | COMMAND

DESCRIPTION
    The abqpy command line interface.

GROUPS
    GROUP is one of the following:

     misc
       The abqpy command line interface.

COMMANDS
    COMMAND is one of the following:

     abaqus
       Run custom Abaqus command: ``abaqus {args} {options}``, arguments are separated by space, options are handled by the :meth:`._parse_options` method.

     adams

     append

     ascfil

     cae
       Run Abaqus/CAE command.

     cosimulation

     cse

     decrypt

     doc

     emloads

     encrypt

     fetch

     findkeyword

     fmu

     fromansys

     fromdyna

     fromnastran

     frompamcrash

     fromradioss

     fromsimpack

     help

     information

     licensing

     make

     moldflow

     mtxasm

     networkDBConnector

     odb2sim

     odbcombine

     odbreport

     optimization
       Run Abaqus optimization command.

     python
       Run Abaqus/Python command.

     restartjoin

     resume

     run
       Run custom command.

     script

     sim_version

     substructurecombine

     substructurerecover

     suspend

     sysVerify

     terminate

     toOutput2

     toexcite

     tonastran

     tosimpack

     tozaero

     upgrade

     viewer
       Run Abaqus/CAE command.

     whereami

Abaqus/CAE Execution Mode

$ abqpy cae --help
INFO: Showing help with the command 'abqpy cae -- --help'.

NAME
    abqpy cae - Run Abaqus/CAE command.

SYNOPSIS
    abqpy cae SCRIPT <flags> [ARGS]...

DESCRIPTION
    Run Abaqus/CAE command.

POSITIONAL ARGUMENTS
    SCRIPT
        Type: 'str'
        The name of the python script to run
    ARGS
        Extra arguments to be passed after the Abaqus/CAE command line options

FLAGS
    -d, --database=DATABASE
        Type: Optional['str | None']
        Default: None
        The name of the database file to open, by default None
    --replay=REPLAY
        Type: Optional['str | None']
        Default: None
        The name of the replay file to open, by default None
    --recover=RECOVER
        Type: Optional['str | None']
        Default: None
        The name of the journal file to open, by default None
    --gui=GUI
        Type: 'bool'
        Default: False
        Run Abaqus/CAE command with the graphical user interface (GUI mode), by default False.
    -e, --envstartup=ENVSTARTUP
        Type: 'bool'
        Default: True
        Execute the Abaqus/CAE startup file, by default True
    --savedOptions=SAVEDOPTIONS
        Type: 'bool'
        Default: True
        Use the saved options, by default True
    --savedGuiPrefs=SAVEDGUIPREFS
        Type: 'bool'
        Default: True
        Use the saved GUI preferences, by default True
    --startupDialog=STARTUPDIALOG
        Type: 'bool'
        Default: True
        Display the startup dialog, by default True
    -c, --custom=CUSTOM
        Type: Optional['str | None']
        Default: None
        The name of the file containing Abaqus GUI Toolkit commands to be executed, by default None
    --guiTester=GUITESTER
        Type: Optional['str | None']
        Default: None
        This option starts a separate user interface containing the Abaqus Python development environment along with Abaqus/CAE.
    --guiRecord=GUIRECORD
        Type: Optional['bool | None']
        Default: None
        Record the GUI commands to a file, by default None

NOTES
    You can also use flags syntax for POSITIONAL ARGUMENTS

Abaqus Python Execution Mode

$ abqpy python --help
INFO: Showing help with the command 'abqpy python -- --help'.

NAME
    abqpy python - Run Abaqus/Python command.

SYNOPSIS
    abqpy python SCRIPT <flags> [ARGS]...

DESCRIPTION
    Run Abaqus/Python command.

POSITIONAL ARGUMENTS
    SCRIPT
        Type: 'str'
        The name of the python script to run
    ARGS
        Extra arguments to be passed after the Abaqus/CAE command line options

FLAGS
    -s, --sim=SIM
        Type: Optional['str | None']
        Default: None
        The name of the simulation file to open, by default None
    -l, --log=LOG
        Type: Optional['str | None']
        Default: None
        The name of the log file to open, by default None

NOTES
    You can also use flags syntax for POSITIONAL ARGUMENTS

Less Frequently Used Commands

$ abqpy misc --help
INFO: Showing help with the command 'abqpy misc -- --help'.

NAME
    abqpy misc - The abqpy command line interface.

SYNOPSIS
    abqpy misc GROUP | COMMAND

DESCRIPTION
    The abqpy command line interface.

GROUPS
    GROUP is one of the following:

     misc
       The abqpy command line interface.

COMMANDS
    COMMAND is one of the following:

     abaqus
       Run custom Abaqus command: ``abaqus {args} {options}``, arguments are separated by space, options are handled by the :meth:`._parse_options` method.

     adams

     append

     ascfil

     cae
       Run Abaqus/CAE command.

     cosimulation

     cse

     decrypt

     doc

     emloads

     encrypt

     fetch

     findkeyword

     fmu

     fromansys

     fromdyna

     fromnastran

     frompamcrash

     fromradioss

     fromsimpack

     help

     information

     licensing

     make

     moldflow

     mtxasm

     networkDBConnector

     odb2sim

     odbcombine

     odbreport

     optimization
       Run Abaqus optimization command.

     python
       Run Abaqus/Python command.

     restartjoin

     resume

     run
       Run custom command.

     script

     sim_version

     substructurecombine

     substructurerecover

     suspend

     sysVerify

     terminate

     toOutput2

     toexcite

     tonastran

     tosimpack

     tozaero

     upgrade

     viewer
       Run Abaqus/CAE command.

     whereami

Comments