|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
.. |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
ansys-grantami-bomanalytics
###########################
Project Overview
----------------
PyGranta BoM Analytics is part of the larger `PyAnsys <https://docs.pyansys.com>`_
effort to facilitate the use of Ansys technologies directly from Python.
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.
Installation
------------
Install the ``ansys-grantami-bomanalytics`` package with this code:
.. code::
pip install ansys-grantami-bomanalytics
To install a release compatible with a specific version of Granta MI, use the
`PyGranta <https://grantami.docs.pyansys.com/>`_ meta-package with a requirement specifier:
.. code::
pip install pygranta==2023.2.0
Alternatively, clone and install this package with this code:
.. code::
git clone https://github.com/ansys/grantami-bomanalytics
cd grantami-bomanalytics
pip install .
Documentation
-------------
The `PyGranta BoM Analytics Documentation <https://bomanalytics.grantami.docs.pyansys.com>`_
provides comprehensive installation and usage information.
Usage
-----
Here's a brief example of how to use PyGranta BoM Analytics:
.. code:: python
# Connect and query the Granta service.
>>> from pprint import pprint
>>> from ansys.grantami.bomanalytics import Connection, queries
>>> cxn = Connection("http://my_grantami_server/mi_servicelayer").with_autologon().connect()
>>> query = (
... queries.MaterialImpactedSubstancesQuery()
... .with_material_ids(['plastic-abs-pvc-flame'])
... .with_legislation_ids(['Candidate_AnnexXV'])
... )
# Print out the result from the query.
>>> result = cxn.run(query)
>>> pprint(result.impacted_substances)
[<ImpactedSubstance: {"cas_number": 10108-64-2, "percent_amount": 1.9}>,
<ImpactedSubstance: {"cas_number": 107-06-2, "percent_amount": None}>,
<ImpactedSubstance: {"cas_number": 115-96-8, "percent_amount": 15.0}>,
...
Testing
-------
For information on testing, see the ``Contributing`` section of the documentation.
License
-------
PyGranta BoM Analytics is provided under the terms of the MIT license. You can find
this license in the LICENSE file at the root of the repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/pyansys/grantami-bomanalytics",
"name": "ansys-grantami-bomanalytics",
"maintainer": "ANSYS, Inc.",
"docs_url": null,
"requires_python": ">=3.9.0,<4.0.0",
"maintainer_email": "pyansys.core@ansys.com",
"keywords": "Ansys,Granta MI,Bill of Materials",
"author": "ANSYS, Inc.",
"author_email": "pyansys.core@ansys.com",
"download_url": "",
"platform": null,
"description": "|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|\n\n.. |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\n :target: https://docs.pyansys.com/\n :alt: PyAnsys\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-grantami-bomanalytics?logo=pypi\n :target: https://pypi.org/project/ansys-grantami-bomanalytics/\n :alt: Python\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ansys-grantami-bomanalytics.svg?logo=python&logoColor=white\n :target: https://pypi.org/project/ansys-grantami-bomanalytics\n :alt: PyPI\n\n.. |codecov| image:: https://codecov.io/gh/ansys/grantami-bomanalytics/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/ansys/grantami-bomanalytics\n :alt: Codecov\n\n.. |GH-CI| image:: https://github.com/ansys/grantami-bomanalytics/actions/workflows/ci_cd.yml/badge.svg\n :target: https://github.com/ansys/grantami-bomanalytics/actions/workflows/ci_cd.yml\n :alt: GH-CI\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: MIT\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat\n :target: https://github.com/psf/black\n :alt: Black\n\n\nansys-grantami-bomanalytics\n###########################\n\nProject Overview\n----------------\nPyGranta BoM Analytics is part of the larger `PyAnsys <https://docs.pyansys.com>`_\neffort to facilitate the use of Ansys technologies directly from Python.\n\nThe MI Restricted Substances and MI Sustainability solutions for Granta MI include REST APIs for:\n\n - Evaluating compliance of products, assemblies, specifications, and\n materials against legislations.\n - Evaluating the environmental performance of products, assemblies, materials and processes.\n\nThis package abstracts automatically-generated code into an easy-to-use client library.\n\n\nInstallation\n------------\nInstall the ``ansys-grantami-bomanalytics`` package with this code:\n\n.. code::\n\n pip install ansys-grantami-bomanalytics\n\nTo install a release compatible with a specific version of Granta MI, use the\n`PyGranta <https://grantami.docs.pyansys.com/>`_ meta-package with a requirement specifier:\n\n.. code::\n\n pip install pygranta==2023.2.0\n\nAlternatively, clone and install this package with this code:\n\n.. code::\n\n git clone https://github.com/ansys/grantami-bomanalytics\n cd grantami-bomanalytics\n pip install .\n\n\nDocumentation\n-------------\nThe `PyGranta BoM Analytics Documentation <https://bomanalytics.grantami.docs.pyansys.com>`_\nprovides comprehensive installation and usage information.\n\n\nUsage\n-----\nHere's a brief example of how to use PyGranta BoM Analytics:\n\n.. code:: python\n\n # Connect and query the Granta service.\n\n >>> from pprint import pprint\n >>> from ansys.grantami.bomanalytics import Connection, queries\n >>> cxn = Connection(\"http://my_grantami_server/mi_servicelayer\").with_autologon().connect()\n >>> query = (\n ... queries.MaterialImpactedSubstancesQuery()\n ... .with_material_ids(['plastic-abs-pvc-flame'])\n ... .with_legislation_ids(['Candidate_AnnexXV'])\n ... )\n\n # Print out the result from the query.\n\n >>> result = cxn.run(query)\n >>> pprint(result.impacted_substances)\n [<ImpactedSubstance: {\"cas_number\": 10108-64-2, \"percent_amount\": 1.9}>,\n <ImpactedSubstance: {\"cas_number\": 107-06-2, \"percent_amount\": None}>,\n <ImpactedSubstance: {\"cas_number\": 115-96-8, \"percent_amount\": 15.0}>,\n ...\n\n\nTesting\n-------\nFor information on testing, see the ``Contributing`` section of the documentation.\n\n\nLicense\n-------\nPyGranta BoM Analytics is provided under the terms of the MIT license. You can find\nthis license in the LICENSE file at the root of the repository.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Perform compliance and sustainability analysis on materials data stored in Granta MI.",
"version": "2.0.0",
"project_urls": {
"Documentation": "https://bomanalytics.grantami.docs.pyansys.com",
"Homepage": "https://github.com/pyansys/grantami-bomanalytics",
"Repository": "https://github.com/pyansys/grantami-bomanalytics"
},
"split_keywords": [
"ansys",
"granta mi",
"bill of materials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "591a96bf8d35cdc82e825662494d11467165e680fe207ec74d240d6b2f236acb",
"md5": "72e58c1a302c857ccc8921d8e1dd8bb5",
"sha256": "fb6ee5b1cbd36ac06c114312d0fbb75ea832249a96cb89f85a96423e5bc5c32b"
},
"downloads": -1,
"filename": "ansys_grantami_bomanalytics-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72e58c1a302c857ccc8921d8e1dd8bb5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0,<4.0.0",
"size": 80744,
"upload_time": "2024-01-17T17:43:54",
"upload_time_iso_8601": "2024-01-17T17:43:54.833059Z",
"url": "https://files.pythonhosted.org/packages/59/1a/96bf8d35cdc82e825662494d11467165e680fe207ec74d240d6b2f236acb/ansys_grantami_bomanalytics-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-17 17:43:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyansys",
"github_project": "grantami-bomanalytics",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ansys-grantami-bomanalytics"
}
JSON
