Getting started

To run PySystemCoupling, you must have a local copy of Ansys System Coupling. Although System Coupling itself does not need a license, you must have licenses for all Ansys products involved in your coupled analysis.

PySystemCoupling supports Ansys System Coupling version 2023 R1 and later.

Note

The detailed documentation, particularly that in the API reference section, is based on the current official Ansys release at this release of PySystemCoupling. This is 2024 R2. Although the majority of it does not change between releases, you should consult the API documentation for an earlier applicable release of PySystemCoupling if you are running with an older System Coupling version and want to be sure of the details.

For more information on getting a licensed copy of Ansys products, visit the Ansys website.

Install PySystemCoupling

The ansys-systemcoupling-core package currently supports Python 3.10 through Python 3.12 on Windows and Linux.

Install the latest release from PyPI with this command:

pip install ansys-systemcoupling-core

Alternatively, install the latest version from PySystemCoupling GitHub with this command:

pip install git https://github.com/ansys/pysystem-coupling.git

If you plan on doing local development of PySystemCoupling with Git, install the latest ansys-systemcoupling-core package with this code:

git clone https://github.com/ansys/pysystem-coupling.git
cd pysystem-coupling
pip install -e .

Launch System Coupling

Launch System Coupling from Python using the launch() function:

import ansys.systemcoupling.core as pysystemcoupling

syc = pysystemcoupling.launch()
syc.ping()

System Coupling is now active and ready to be used as a service. For information on using the PySystemCoupling interface, see the User guide.