ansys-platform-instancemanagement 1.2.0

Installation

The ansys-platform-instancemanagement package is tested for Python 3.10 through Python 3.14 on Windows and Linux.

pip install ansys-platform-instancemanagement

Configuration

By default, PyPIM is configured externally instead of via code. Anywhere in the local storage, create a configuration file with this format:

{
    "version": 1,
    "pim": {
        "uri": "dns:pim.svc.com:80",
        "headers": {
            "metadata-info": "value"
        },
        "tls": false
    }
}

Then, define the environment variable ANSYS_PLATFORM_INSTANCEMANAGEMENT_CONFIG to point to this configuration file.

Security

By default, the connection to the PIM server is insecure. To use TLS, mutual TLS (mTLS), a Unix Domain Socket (UDS), or Windows Named User Authentication (WNUA) instead, either use a version 2 configuration file with a security block or pass the settings directly to connect():

import ansys.platform.instancemanagement as pypim
from ansys.platform.instancemanagement import ConnectionSecurity
from ansys.tools.common.cyberchannel import CertificateFiles

client = pypim.connect(
    uri="dns:pim.svc.com:80",
    security=ConnectionSecurity(
        transport="mtls",
        cert_files=CertificateFiles(
            cert_file="client.crt", key_file="client.key", ca_file="ca.crt"
        ),
    ),
)

Product instances started with create_instance() can also request a transport with the security_settings parameter, and the transport a running instance actually uses is reported back on each of its services. See Security in the PyPIM documentation for the full configuration file schema and all supported transports.

Usage

PyPIM is a single module called ansys.platform.instancemanagement, shortened to pypim.

To start MAPDL and communicate with PyPIM, use this code:

import ansys.platform.instancemanagement as pypim
from ansys.mapdl.core import Mapdl

if pypim.is_configured():
    with pypim.connect() as pim:
        with pim.create_instance(
            product_name="mapdl", product_version="221"
        ) as instance:
            instance.wait_for_ready()
            channel = instance.build_grpc_channel(
                options=[("grpc.max_receive_message_length", 8 * 1024**2)]
            )
            mapdl = Mapdl(channel=channel)
            mapdl.prep7()
            ...

You can also use PyPIM without the with statement, as shown in this code:

import ansys.platform.instancemanagement as pypim
from ansys.mapdl.core import Mapdl

if pypim.is_configured():
    pim = pypim.connect()
    instance = pim.create_instance(product_name="mapdl", product_version="221")
    channel = instance.build_grpc_channel(
        options=[("grpc.max_receive_message_length", 8 * 1024**2)]
    )
    mapdl = Mapdl(channel=channel)
    mapdl.prep7()
    ...
    instance.delete()
    pim.close()

Integration

PyPIM can be integrated in PyAnsys libraries to transparently switch to a remote instance in a suitable environment. This process is described in Integration in the PyPIM documentation.

For example, starting MAPDL with PyPIM is as simple as using this code:

from ansys.mapdl.core import launch_mapdl

mapdl = launch_mapdl()

Ansys developer ecosystem resources

Ansys has an extensive developer ecosystem where you can find assistance for a variety of issues.

• Developer Portal <https://developer.ansys.com/>: Blog posts, documentation, and guide

• Developer Forum <https://discuss.ansys.com/>: Scripting and usage support for PyAnsys and other Ansys developer tools

• Ansys Innovation Space <https://innovationspace.ansys.com/>: Product support forum and training materials

• GitHub <https://github.com/ansys/pypim>: Development support, bug reporting, feature requests, and more.

• Ansys Learning Hub <https://learninghub.ansys.com/>: Training, courses and learning plans