Getting started

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.10 to version 3.13.

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

To see which individual PyGranta package versions are installed with each version of the PyGranta metapackage, consult the Package versions section of the PyGranta documentation.

Alternatively, to install the latest development version 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 PyGranta 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>

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 RecordLists and can start using the RecordLists client. For more examples, see Examples. For comprehensive information on the API, see API reference.