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.

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.7 through Python 3.10 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/pyansys/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/pyansys/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.