abqpy.cli

Module Contents

Classes

AbqpyCLIBase	Base class for Abaqus/CAE command line interface to run Abaqus commands.
AbqpyCLI	The abqpy command line interface.

Attributes

abaqus

class AbqpyCLIBase

Base class for Abaqus/CAE command line interface to run Abaqus commands.

Public Methods:

run(cmd)	Run custom command.
abaqus(*args, **options)	Run custom Abaqus command: abaqus {args} {options}, arguments are separated by space, options are handled by the _parse_options() method.

Private Methods:

_parse_options(**options)

Parse options to be passed to Abaqus/CAE command line interface.

---

_parse_options(**options: str | int | bool | None) → str

Parse options to be passed to Abaqus/CAE command line interface.

If the value is a string or an integer, the option will be passed as option=value; if the value is a boolean, the option will be passed as option if True, or ignored if False; if the value is None, the option will be ignored.

run(cmd: str)

Run custom command.

abaqus(*args, **options)

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

Parameters:

• args – Arguments and options to be passed to the Abaqus command.

• options – Arguments and options to be passed to the Abaqus command.

class AbqpyCLI

Bases: AbqpyCLIBase

The abqpy command line interface.

Public Data Attributes:

misc	Miscellaneous commands for backward compatibility.

Public Methods:

cae(script, *args[, database, replay, ...])	Run Abaqus/CAE command.
viewer(script, *args[, database, replay, ...])	Run Abaqus/CAE command.
python(script, *args[, sim, log])	Run Abaqus/Python command.
optimization(task, job, *[, cpus, gpus, ...])	Run Abaqus optimization command.
help(*args, **options)
information(*args, **options)
whereami(*args, **options)
cse(*args, **options)
cosimulation(*args, **options)
fmu(*args, **options)
script(*args, **options)
doc(*args, **options)
licensing(*args, **options)
ascfil(*args, **options)
append(*args, **options)
findkeyword(*args, **options)
fetch(*args, **options)
make(*args, **options)
upgrade(*args, **options)
sim_version(*args, **options)
odb2sim(*args, **options)
odbreport(*args, **options)
restartjoin(*args, **options)
substructurecombine(*args, **options)
substructurerecover(*args, **options)
odbcombine(*args, **options)
networkDBConnector(*args, **options)
emloads(*args, **options)
mtxasm(*args, **options)
fromnastran(*args, **options)
tonastran(*args, **options)
fromansys(*args, **options)
frompamcrash(*args, **options)
fromradioss(*args, **options)
toOutput2(*args, **options)
fromdyna(*args, **options)
tozaero(*args, **options)
adams(*args, **options)
tosimpack(*args, **options)
fromsimpack(*args, **options)
toexcite(*args, **options)
moldflow(*args, **options)
encrypt(*args, **options)
decrypt(*args, **options)
suspend(*args, **options)
resume(*args, **options)
terminate(*args, **options)
sysVerify(*args, **options)

Inherited from AbqpyCLIBase

run(cmd)	Run custom command.
abaqus(*args, **options)	Run custom Abaqus command: abaqus {args} {options}, arguments are separated by space, options are handled by the _parse_options() method.

Private Methods:

Inherited from AbqpyCLIBase

_parse_options(**options)

Parse options to be passed to Abaqus/CAE command line interface.

---

property misc: typing_extensions.Self

Miscellaneous commands for backward compatibility.

viewer

cae(script: str, *args, database: str | None = None, replay: str | None = None, recover: str | None = None, gui: bool = False, envstartup: bool = True, savedOptions: bool = True, savedGuiPrefs: bool = True, startupDialog: bool = True, custom: str | None = None, guiTester: str | None = None, guiRecord: bool | None = None)

Run Abaqus/CAE command.

Parameters:

• script (str) – The name of the python script to run

• args (str) – Extra arguments to be passed after the Abaqus/CAE command line options

• database (str, optional) – The name of the database file to open, by default None

• replay (str, optional) – The name of the replay file to open, by default None

• recover (str, optional) – The name of the journal file to open, by default None

• gui (bool, optional) – Run Abaqus/CAE command with the graphical user interface (GUI mode), by default False.

• envstartup (bool, optional) – Execute the Abaqus/CAE startup file, by default True

• savedOptions (bool, optional) – Use the saved options, by default True

• savedGuiPrefs (bool, optional) – Use the saved GUI preferences, by default True

• startupDialog (bool, optional) – Display the startup dialog, by default True

• custom (str, optional) – The name of the file containing Abaqus GUI Toolkit commands to be executed, by default None

• guiTester (str, optional) – This option starts a separate user interface containing the Abaqus Python development environment along with Abaqus/CAE.

• guiRecord (bool, optional) – Record the GUI commands to a file, by default None

python(script: str, *args, sim: str | None = None, log: str | None = None)

Run Abaqus/Python command.

Parameters:

• script (str) – The name of the python script to run

• args (str) – Extra arguments to be passed after the Abaqus/CAE command line options

• sim (str, optional) – The name of the simulation file to open, by default None

• log (str, optional) – The name of the log file to open, by default None

optimization(task: str, job: str, *, cpus: int | None = None, gpus: int | None = None, memory: int | None = None, interactive: bool = False, globalmodel: str | None = None, scratch: str | None = None)

Run Abaqus optimization command.

Parameters:

• task (str) – The file containing the parameters that are used to execute the optimization.

• job (str) – The name of the folder in which the results of the optimization are stored.

• cpus (int, optional) – The number of processors to use during an analysis run if parallel processing is available.

• gpus (int, optional) – This acceleration of the Abaqus/Standard direct solver.

• memory (int, optional) – Maximum amount of memory or maximum percentage of the physical memory that can be allocated.

• interactive (bool, optional) – This option will cause the job to run interactively.

• globalmodel (str, optional) – The name of the global model’s results file, ODB output database file, or SIM database file.

• scratch (str, optional) – The name of the directory used for scratch files.

help(*args, **options)

information(*args, **options)

whereami(*args, **options)

cse(*args, **options)

cosimulation(*args, **options)

fmu(*args, **options)

script(*args, **options)

doc(*args, **options)

licensing(*args, **options)

ascfil(*args, **options)

append(*args, **options)

findkeyword(*args, **options)

fetch(*args, **options)

make(*args, **options)

upgrade(*args, **options)

sim_version(*args, **options)

odb2sim(*args, **options)

odbreport(*args, **options)

restartjoin(*args, **options)

substructurecombine(*args, **options)

substructurerecover(*args, **options)

odbcombine(*args, **options)

networkDBConnector(*args, **options)

emloads(*args, **options)

mtxasm(*args, **options)

fromnastran(*args, **options)

tonastran(*args, **options)

fromansys(*args, **options)

frompamcrash(*args, **options)

fromradioss(*args, **options)

toOutput2(*args, **options)

fromdyna(*args, **options)

tozaero(*args, **options)

adams(*args, **options)

tosimpack(*args, **options)

fromsimpack(*args, **options)

toexcite(*args, **options)

moldflow(*args, **options)

encrypt(*args, **options)

decrypt(*args, **options)

suspend(*args, **options)

resume(*args, **options)

terminate(*args, **options)

sysVerify(*args, **options)

abaqus