Export setup

Simcenter Amesim provides a complete set of Object oriented API functions in Python to automate Export Setup handling. This is called the Export Setup API. Using these sets of APIs you can handle Export Setup without using the Simcenter Amesim application, all you need is the Simcenter Amesim model in its expanded state. A typical case for using this API is in conjunction with the Design Exploration API, which requires export parameters to be set before accessing the design exploration studies in a model.

To set up an export configuration with the API, the user needs to know and understand some key concepts.

Each concept is represented by an object in the ame_export_apy module. The details of each object are as given in the following sections.

The XPT Manager (XPTManager)

This is the topmost object in charge of handling all studies for all Simcenter Amesim models. It results from the fact that it is possible to have export setup parameters for multiple models simultaneously, since this is the case with the Design Exploration API. The XPT manager is responsible for the simultaneous handling of configuration of multiple model files.

The Export Config Handler (XPTConfig)

The Export Config Handler allows you to manipulate the export setup configuration for one model file. It is possible to retrieve, add or delete export setup parameters using this handler.

The Export Parameter Handler (XPTParam)

The Export Parameter Handler allows you to retrieve or modify the values of the different columns in an export parameter.