AmesimKnowledge

The Circuit API

Introduction

Simcenter Amesim™ software provides a complete set of API functions to write short programs in higher abstraction level languages, like Python, C and Visual Basic for Applications, that automate interaction with models.

Note

As of Simcenter Amesim 16, the Circuit API is only available in 64-bits.

This manual gives an exhaustive list of these functions with a short description for each. These functions are particularly designed for automating tasks, such as setting or getting parameter values, running temporal simulations or linear analysis, and post-processing result variables. These tasks may be combined to build small or larger applications that, for example:

  • create models from scratch,

  • add, move, rotate and connect components on the sketch,

  • assign submodels to components,

  • compile a model,

  • set run parameters,

  • automate runs,

  • perform complex and automated pre-processing: parameter checking and dependant, parameter calculations,

  • perform complex post-processing: creating 2D or 3D plots, animations, performing signal analysis, such as FFT, spectral estimation...

  • build custom GUIs for pre- or post-processing,

  • integrate an Simcenter Amesim model within an external application, reading and writing files with user-defined formats, connecting to databases, communicating over networks,

  • execute an optimization loop on an Simcenter Amesim model etc.

API functions are usually easy and fast to develop, as the scripting languages provide powerful abstractions such as lists, hash tables, matrices, and numerous toolboxes for file handling, numerical analysis, and graphical post-processing of large data sets. In addition, all scripting languages except Visual Basic for Applications (which is limited to Windows) are platform-independent.

Source: https://docs.sw.siemens.com/en-US/doc/254352342/PL20250521841123434.amesim_collection.Circuit_API/xid882137 · retrieved 2026-07-17