You can get help from within the System Coupling CLI using any of the following methods:
Help on Python Usage
To obtain usage information from the Python interpreter's help utility, use the help() command as follows:
To access interactive help, type:
help()
To get information on an object, type:
help(
object
)To exit the help utility, type:
quit
Help on System Coupling Command-Line Options
Before starting the System Coupling CLI, you can get information on the command-line options that can be applied when System Coupling's execution script is run. To do so, you can use either the -h or --help command-line option when running the execution script. For example:
"%AWP_ROOT242%\SystemCoupling\bin\systemcoupling" --help
Descriptions of the available options will be written to the CLI, which will then close. To start System Coupling, you must run the executable again without the -h or --help option.
Available startup options are described in Command-Line Options in the System Coupling Settings and Commands Reference.
Help on System Coupling Commands
To obtain help on commands from within the System Coupling CLI, type in
help(<
.
For example:command
>)
help(Initialize) Help on function Initialize: Initialize(**kwds) Description : Interactive command that initializes a coupled analysis. This includes preparing the coupling service, establishing connections between the coupling service and all participants, and writing participant build information to the transcript. Supported keyword arguments : Essential arguments : Return type is NoneType
Available commands are described in Commands in the System Coupling Settings and Commands Reference.