Getting started

Procedure

1. Start the Python command interpreter. In Simcenter Amesim, use Tools > Python command interpreter Python Command Interpreter .

Figure 1: Starting the Python command interpreter

2. Check the circuit API version. Type AMEGetAPIVersion() AMEGetAPIVersion

Figure 2: Getting the API Version

3. Initialize the API.

Now we need to initialize the circuit API, by calling the AMEInitAPI

  AMEInitAPI
 command. It is necessary to initialize the API before using API functions (except for functions that simply return information, such as AMEGetAPIVersion). Otherwise, you will get error messages.

Type AMEInitAPI(). Figure 3: Initializing the API

Results

Note that we use the optional boolean argument False, which indicates that we do not want to index the submodels in the path list. Please consult the Circuit API Reference Manual for details about this argument.

Note

Calling AMEInitAPI checks out one Simcenter Amesim license token. The license is released after you call AMECloseAPI AMECloseAPI .