Getting started

Ansys software requirements

To use this version of the ansys.grantami.recordlists package you must have access to a Granta MI 2024 R2 deployment.

The ansys.grantami.recordlists package currently supports Python from version 3.9 to version 3.12.

Installation

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

pip install ansys-grantami-recordlists

To install a release compatible with a specific version of Granta MI, use the PyGranta meta-package with a requirement specifier:

pip install pygranta==2023.2.0

Alternatively, to install the latest from ansys-grantami-recordlists GitHub, use this code:

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

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

git clone https://github.com/ansys/grantami-recordlists
cd grantami-recordlists
poetry install

The preceding code installs the package 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 RecordLists client from Python by running this code:

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

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

If you see a response from the server, you have successfully installed the RecordLists package and you can start using the RecordLists client. See Examples for more examples and API reference for a full description of the API.