Skip to content

ansys/pygranta

Repository files navigation

PyGranta metapackage

PyAnsys Python PyPI GH-CI MIT Black pre-commit.ci status

Welcome to the PyGranta metapackage repository. The pygranta metapackage provides a single package of collected PyGranta packages that ensures compatibility of these packages amongst themselves and the Granta MI release that they are linked to.

The pygranta metapackage ensures compatibility between these PyGranta packages:

  • BoM Analytics: Pythonic interface to the Ansys Granta MI BoM Analytics services.
  • RecordLists: Pythonic interface to the Ansys Granta MI Lists API.
  • serverapi-openapi: Autogenerated client library for the Ansys Granta MI Server API Services.

The PyGranta metapackage installs these core modules and their dependencies:

Documentation

Documentation for the latest stable release of PyGranta is hosted at PyGranta documentation. The documentation has four sections:

  • Getting started: Describes how to install PyGranta in user mode.
  • User guide: Describes how to use PyGranta.
  • API reference: Provides API member descriptions and usage examples.
  • Examples: Provides examples showing end-to-end workflows for using PyGranta.

License and acknowledgments

All PyGranta libraries are licensed under the MIT license.

PyGranta libraries make no commercial claim over Ansys whatsoever. These libraries extend the functionality of Ansys products by adding Python interfaces to legally obtained software products without changing the core behaviors or licenses of the original software.

For more information on Ansys products, visit the Ansys website.