ansys-grantami-bomanalytics 2.4.0rc0
Perform compliance and sustainability analysis on materials data stored in Granta MI.
License: MIT
Requires Python: <4.0.0,>=3.10.0
Keywords: Ansys, Granta MI, Bill of Materials

|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| |pre-commit-ci|

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
   :target: https://docs.pyansys.com/
   :alt: PyAnsys

.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-grantami-bomanalytics?logo=pypi
   :target: https://pypi.org/project/ansys-grantami-bomanalytics/
   :alt: Python

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-grantami-bomanalytics.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/ansys-grantami-bomanalytics
   :alt: PyPI

.. |codecov| image:: https://codecov.io/gh/ansys/grantami-bomanalytics/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/ansys/grantami-bomanalytics
   :alt: Codecov

.. |GH-CI| image:: https://github.com/ansys/grantami-bomanalytics/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/ansys/grantami-bomanalytics/actions/workflows/ci_cd.yml
   :alt: GH-CI

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: MIT

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
   :target: https://github.com/psf/black
   :alt: Black

.. |pre-commit-ci| image:: https://results.pre-commit.ci/badge/github/ansys/grantami-bomanalytics/main.svg
   :target: https://results.pre-commit.ci/latest/github/ansys/grantami-bomanalytics/main
   :alt: pre-commit.ci status


PyGranta BoM Analytics
======================

..
   _after-badges

The MI Restricted Substances and MI Sustainability solutions for Granta MI include REST APIs for:

- Evaluating compliance of products, assemblies, specifications, and
  materials against legislations.
- Evaluating the environmental performance of products, assemblies, materials and processes.

This package abstracts automatically-generated code into an easy-to-use client library.


Dependencies
------------
.. readme_software_requirements

This version of the ``ansys.grantami.bomanalytics`` package requires MI Restricted Substances and Sustainability Reports
2024 R2 or later. Use
`the PyGranta documentation <https://grantami.docs.pyansys.com/version/stable/package_versions>`_ to find the
version of this package compatible with older MI Restricted Substances and Sustainability Reports versions.

``MI Restricted Substances`` and ``MI Sustainability`` are licensed separately. Endpoints available to end users depend
on the available licenses.

The ``ansys.grantami.bomanalytics`` package currently supports Python version 3.10 through 3.14.

.. readme_software_requirements_end


Installation
------------
.. readme_installation

To install the latest PyGranta BoM Analytics release from
`PyPI <https://pypi.org/project/ansys-grantami-bomanalytics/>`_, run this command:

.. code::

    pip install ansys-grantami-bomanalytics

To install a release compatible with a specific version of Granta MI Restricted Substances and Sustainability Reports,
install the `PyGranta <https://grantami.docs.pyansys.com/>`_ metapackage with a requirement specifier:

.. code::

    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 <https://grantami.docs.pyansys.com/version/dev/package_versions.html>`_ section of the PyGranta
documentation.

Alternatively, to install the latest development version from the
`PyGranta BoM Analytics repository <https://github.com/ansys/grantami-bomanalytics>`_, run this command:

.. code::

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


To install a local *development* version with Git and Poetry, run these commands:

.. code::

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


The preceding commands install the package in development mode so that you can modify
it locally. Your changes are reflected in your Python setup after restarting the Python kernel.

.. readme_installation_end