Environment Variables¶
The following environment variables can be used to configure the package.
- ABAQUS_BAT_PATH¶
Type: string
The file path of the
abaqus
command line batch file (.bat
). Only set this environment variable ifabaqus
is not the default Abaqus command line executable. This variable is used byabqpy
to run the Abaqus command line procedure inside the Python interpreter environment where it is installed.
- ABAQUS_COMMAND_OPTIONS¶
Type: string of a Python dictionary
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:When there is a
import abaqus
orfrom abaqus import ...
statement:abaqus cae noGUI=script.py -- [args ...]
When there is a
import odbAccess
orfrom odbAccess import ...
statement:abaqus 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 define these procedures and options you can create a new system environment variable namedABAQUS_COMMAND_OPTIONS
, and set a dictionary to this variable with the options you want to use. The values of the dictionary keys would be booleans or strings, e.g.:{'gui': True, 'database': 'file.odb'}
The possible options are:
Using
abaqus cae
command line options (importabaqus
module):Using
abaqus python
command line options (importodbAccess
module):{ "sim": "sim_file_name", "log": "log_file_name", }
One advantage in using this alternative is to change the options at run time inside the code.
Note
The environment variable
ABAQUS_COMMAND_OPTIONS
must be a valid string that can be parsed to a Python dictionary, which means that you must useTrue
orFalse
for boolean options. However, in the following individual environment variables, you can usetrue
,on
,yes
or1
(or capitalized ones since they are not case sensitive) to set the boolean option toTrue
and any other values to set it toFalse
.
- ABAQUS_CAE_DATABASE¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thedatabase
option but has higher priority.
- ABAQUS_CAE_REPLAY¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thereplay
option but has higher priority.
- ABAQUS_CAE_RECOVER¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set therecover
option but has higher priority.
- ABAQUS_CAE_STARTUP¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thestartup
option but has higher priority.
- ABAQUS_CAE_GUI¶
Type: bool {true, false, on, off, yes, no, 1, 0}
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thegui
option but has higher priority.
- ABAQUS_CAE_ENVSTARTUP¶
Type: bool {true, false, on, off, yes, no, 1, 0}
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set theenvstartup
option but has higher priority.
- ABAQUS_CAE_SAVED_OPTIONS¶
Type: bool {true, false, on, off, yes, no, 1, 0}
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thesavedOptions
option but has higher priority.
- ABAQUS_CAE_SAVED_GUI_PREFS¶
Type: bool {true, false, on, off, yes, no, 1, 0}
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thesavedGuiPrefs
option but has higher priority.
- ABAQUS_CAE_STARTUP_DIALOG¶
Type: bool {true, false, on, off, yes, no, 1, 0}
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thestartupDialog
option but has higher priority.
- ABAQUS_CAE_CUSTOM¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thecustom
option but has higher priority.
- ABAQUS_CAE_GUI_TESTER¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set theguiTester
option but has higher priority.
- ABAQUS_CAE_GUI_RECORD¶
Type: bool {true, false, on, off, yes, no, 1, 0}
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set theguiRecord
option but has higher priority.
- ABAQUS_PYTHON_SIM¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thesim
option but has higher priority.
- ABAQUS_PYTHON_LOG¶
Type: string
A shortcut to the
ABAQUS_COMMAND_OPTIONS
environment variable to set thelog
option but has higher priority.
Example¶
The snippet bellow changes the default procedure options before calling abaqus cae command procedure, at run time.
import os
os.environ["ABAQUS_COMMAND_OPTIONS"] = str({"gui": True, "database": "file.odb"})
from abaqus import *
...
In this specific case, the procedure will use the graphical user interface (GUI mode) and load a database file, i.e., it will run the following command line.
abaqus cae script=script.py database=file.odb -- [args ...]