API reference#

There are three main levels of interaction with the PySystemCoupling API:

  • Launching or connecting to a System Coupling server instance by calling the launch or connect function. These functions return a Session object that you use to interact with the System Coupling server.

  • The Session object itself provides some high-level capabilities such as controlling streaming of standard streams from the server and lifetime management of the session. It also contains three important attributes: case, setup and solution, through which you gain access to the third aspect of the API.

  • The case, setup and solution attributes of the Session object are root objects that constitute an entry point to an adaptor API for core System Coupling features. The bulk of the PySystemCoupling API resides under these root object. This is where most of the interactions required to set up and solve a coupled analysis take place.