Getting started

Software requirements

This version of the ansys.grantami.system package requires Granta MI 2026 R1 or later.

The ansys.grantami.system package currently supports Python from version 3.10 to version 3.14.

Installation

To install the latest release from PyPI, use this code:

pip install ansys-grantami-system

Alternatively, to install the latest development version from ansys-grantami-system GitHub, use this code:

pip install git+https://github.com/ansys/grantami-system.git

To install a local development version with Git and uv, use this code:

git clone https://github.com/ansys/grantami-system
cd grantami-system
uv sync

The preceding code installs the package (with development dependencies) and allows you to modify it locally, with your changes reflected in your Python setup after restarting the Python kernel.

Verify your installation

Check that you can start the PyGranta System client from Python by running this code:

>>> from ansys.grantami.system import Connection
>>> client = Connection("http://my.server.name/mi_servicelayer").with_autologon().connect()
>>> print(client)

<SystemApiClient url: http://my.server.name/mi_servicelayer>

This example uses Windows-based autologon authentication. For all supported authentication schemes, see the OpenAPI-Common documentation.

If you see a response from the server, you have successfully installed PyGranta System and can start using the Granta MI System client. For more examples, see Examples. For comprehensive information on the API, see API reference.