ansys-platform-instancemanagement

What it is and what it does

PyPIM is a Python wrapper around the Ansys Product Instance Management (PIM) gRPC API. It lets you start and manage Ansys products (like MAPDL) in remote environments and communicate with their APIs without needing to understand the underlying infrastructure. The package is pure Python and relies on gRPC for transport.

The PIM API itself is intentionally minimal—it assumes all configuration happens on the server side. You only need to know which product to start and which API it exposes. PyPIM is not designed for stateless services, job management, or full service orchestration; it focuses on managing service-oriented applications with a small, focused feature set. Configuration is external (via a JSON file and environment variable), and the package supports multiple security transports including TLS, mutual TLS, Unix Domain Sockets, and Windows Named User Authentication.

Use it for:

• Start MAPDL or other Ansys products in a remote environment and interact with them via gRPC channels from Python code.
• Integrate PyPIM into PyAnsys libraries to transparently switch between local and remote product instances based on environment.
• Build service-oriented applications that need to spawn and manage Ansys product instances on demand.
• Configure secure connections to PIM servers using mTLS or other transport security mechanisms.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

PyPIM provides a Python client to communicate with the Ansys Product Instance Management (PIM) API, a gRPC service for starting and managing remote product instances.

Yes, if you have access to a configured PIM API server and need to manage Ansys product instances remotely. The package is actively maintained, has low install friction, and uses a permissive MIT license. However, the PIM service itself is not publicly exposed, so this is primarily useful within Ansys infrastructure or authorized environments. Check with your Ansys administrator or the documentation to confirm access before installing.

Install

ansys-platform-instancemanagement on PyPI

pip install ansys-platform-instancemanagement

uv add ansys-platform-instancemanagement

poetry add ansys-platform-instancemanagement

Installing ansys-platform-instancemanagement

Before you install

Low install friction with a pure-Python wheel and three runtime dependencies. The package is actively maintained with a recent release and supports Python 3.10 through 3.14.

License in practice

Licensed under MIT, a permissive license that allows commercial and private use with minimal restrictions.

Quickstart

pip install ansys-platform-instancemanagement

import ansys.platform.instancemanagement as pypim

if pypim.is_configured():
    with pypim.connect() as pim:
        instance = pim.create_instance(product_name="mapdl", product_version="221")
        instance.wait_for_ready()

Requires access to a configured PIM API server; the service itself is not publicly exposed. Configuration via ANSYS_PLATFORM_INSTANCEMANAGEMENT_CONFIG environment variable pointing to a JSON config file is mandatory.

Verify before relying

• Whether the PIM service is now publicly available or remains restricted to Ansys infrastructure
• Specific gRPC version requirements or compatibility constraints beyond what the dependencies specify

Package facts

Evidence: ansys_platform_instancemanagement-1.2.0-py3-none-any.whl

Tags

More Distributed Computing packages