feat: change granta packages to pygranta metapackage (#460)

* feat: change granta packages to pygranta metapackage

* fix: issues

Author: RobPasMue

.github/workflows/create-milestone.yml

@@ -30,6 +30,7 @@ jobs:
             "ansys/pydynamicreporting",
             "ansys/pyensight",
             "ansys/pyfluent",
+            "ansys/pygranta",
             "ansys/pymapdl",
             "ansys/pymechanical",
             "ansys/pymotorcad",
@@ -41,8 +42,6 @@ jobs:
             "ansys/pysystem-coupling",
             "ansys/pyturbogrid",
             "ansys/pytwin",
-            "ansys/grantami-bomanalytics",
-            "ansys/grantami-recordlists",
             "ansys/openapi-common",
             # MAPDL - ALL
             "ansys/pymapdl-reader",

README.rst

@@ -49,6 +49,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 - `PyFluent <https://fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent.
 - `PyFluent - Parametric <https://parametric.fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent parametric workflows.
 - `PyFluent - Visualization <https://visualization.fluent.docs.pyansys.com/>`_: Pythonic interface to visualize Ansys Fluent simulations.
+- `PyGranta <https://grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI services.
 - `PyMAPDL <https://mapdl.docs.pyansys.com/>`_: Pythonic interface to Ansys MAPDL (Mechanical APDL).
 - `PyMAPDL Reader <https://reader.docs.pyansys.com/>`_: Pythonic interface to read legacy MAPDL result files (MAPDL 14.5 and later).
 - `PyMechanical <https://mechanical.docs.pyansys.com/>`_: Pythonic interface to Ansys Mechanical.
@@ -61,8 +62,6 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 - `PySystemCoupling <https://systemcoupling.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys System Coupling.
 - `PyTurboGrid <https://turbogrid.docs.pyansys.com/>`_: Pythonic interface to Ansys TurboGrid, a high-quality turbomachinery meshing software app.
 - `PyTwin <https://twin.docs.pyansys.com/>`_: Pythonic interface to communicate with consumption workflows for Ansys digital twins.
-- `Granta MI BoM Analytics <https://bomanalytics.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI BoM Analytics services.
-- `Granta MI RecordLists <https://recordlists.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI Lists API.
 - `Shared Components <https://shared.docs.pyansys.com/>`_: Shared Ansys software components to enable package interoperability and minimize maintenance.
 
 Other tools delivered as part of the metapackage are:
@@ -91,6 +90,7 @@ By default, the PyAnsys metapackage installs these core modules:
 - `PyDynamicReporting`_
 - `PyEnSight`_
 - `PyFluent`_
+- `PyGranta`_
 - `PyMAPDL`_
 - `PyMechanical`_
 - `PyMotorCAD`_
@@ -102,8 +102,6 @@ By default, the PyAnsys metapackage installs these core modules:
 - `PySystemCoupling`_
 - `PyTurboGrid`_
 - `PyTwin`_
-- `Granta MI BoM Analytics`_
-- `Granta MI RecordLists`_
 - `Shared Components`_
 
 Additionally, the ``pyansys`` metapackage contains certain extra targets that

doc/source/api.rst

@@ -99,6 +99,12 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyGranta
+      :img-top: _static/thumbnails/intro.png
+      :link: https://grantami.docs.pyansys.com/version/stable/api.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMAPDL
       :img-top: _static/thumbnails/pymapdl.png
       :link: https://mapdl.docs.pyansys.com/version/stable/api/index.html
@@ -171,18 +177,6 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: Granta MI BoM Analytics
-      :img-top: _static/thumbnails/intro.png
-      :link: https://bomanalytics.grantami.docs.pyansys.com/version/stable/api/index.html
-      :text-align: center
-      :class-title: pyansys-card-title
-
-    .. grid-item-card:: Granta MI RecordLists
-      :img-top: _static/thumbnails/intro.png
-      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/api/index.html
-      :text-align: center
-      :class-title: pyansys-card-title
-
     .. grid-item-card:: Shared Components - OpenAPI Common
       :img-top: _static/thumbnails/intro.png
       :link: https://openapi.docs.pyansys.com/api/index.html

doc/source/examples.rst

@@ -88,6 +88,12 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyGranta
+      :img-top: _static/thumbnails/intro.png
+      :link: https://grantami.docs.pyansys.com/version/stable/examples.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMAPDL
       :img-top: _static/thumbnails/pymapdl.png
       :link: https://mapdl.docs.pyansys.com/version/stable/examples/index.html
@@ -160,18 +166,6 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: Granta MI BoM Analytics
-      :img-top: _static/thumbnails/intro.png
-      :link: https://bomanalytics.grantami.docs.pyansys.com/version/stable/examples/index.html
-      :text-align: center
-      :class-title: pyansys-card-title
-
-    .. grid-item-card:: Granta MI RecordLists
-      :img-top: _static/thumbnails/intro.png
-      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/examples/index.html
-      :text-align: center
-      :class-title: pyansys-card-title
-
     .. grid-item-card:: Shared Components - OpenAPI Common
       :img-top: _static/thumbnails/intro.png
       :link: https://openapi.docs.pyansys.com/index.html#brief-example

doc/source/index.rst

@@ -122,6 +122,14 @@ it is now a collection of many Python packages for using Ansys products through
 
       Pythonic interface to visualize Ansys Fluent simulations
 
+    .. grid-item-card:: PyGranta
+      :img-top: _static/thumbnails/intro.png
+      :link: https://grantami.docs.pyansys.com/version/stable
+      :text-align: center
+      :class-title: pyansys-card-title
+
+      Pythonic interface to Ansys Granta MI services
+
     .. grid-item-card:: PyMAPDL
       :img-top: _static/thumbnails/pymapdl.png
       :link: https://mapdl.docs.pyansys.com/version/stable
@@ -218,25 +226,9 @@ it is now a collection of many Python packages for using Ansys products through
 
       Pythonic interface to communicate with consumption workflows for Ansys digital twins
 
-    .. grid-item-card:: Granta MI BoM Analytics
-      :img-top: _static/thumbnails/intro.png
-      :link: https://bomanalytics.grantami.docs.pyansys.com/version/stable
-      :text-align: center
-      :class-title: pyansys-card-title
-
-      Pythonic interface to Ansys Granta MI BoM Analytics services
-
-    .. grid-item-card:: Granta MI RecordLists
-      :img-top: _static/thumbnails/intro.png
-      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/
-      :text-align: center
-      :class-title: pyansys-card-title
-
-      Pythonic interface to Ansys Granta MI Lists API
-
     .. grid-item-card:: Shared Components
       :img-top: _static/thumbnails/intro.png
-      :link: https://shared.docs.pyansys.com/
+      :link: https://shared.docs.pyansys.com
       :text-align: center
       :class-title: pyansys-card-title
 

doc/source/user_guide.rst

@@ -91,6 +91,12 @@ PyAnsys packages user guides
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PyGranta
+      :img-top: _static/thumbnails/intro.png
+      :link: https://grantami.docs.pyansys.com/version/stable/user_guide.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PyMAPDL
       :img-top: _static/thumbnails/pymapdl.png
       :link: https://mapdl.docs.pyansys.com/version/stable/user_guide/index.html
@@ -163,18 +169,6 @@ PyAnsys packages user guides
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: Granta MI BoM Analytics
-      :img-top: _static/thumbnails/intro.png
-      :link: https://bomanalytics.grantami.docs.pyansys.com/version/stable/getting_started/index.html
-      :text-align: center
-      :class-title: pyansys-card-title
-
-    .. grid-item-card:: Granta MI RecordLists
-      :img-top: _static/thumbnails/intro.png
-      :link: https://recordlists.grantami.docs.pyansys.com/version/stable/getting_started/index.html
-      :text-align: center
-      :class-title: pyansys-card-title
-
     .. grid-item-card:: Shared Components - OpenAPI Common
       :img-top: _static/thumbnails/intro.png
       :link: https://openapi.docs.pyansys.com/index.html

doc/styles/Vocab/ANSYS/accept.txt

@@ -14,7 +14,6 @@ PyDPF - Composites
 PyDPF
 PyFluent
 PyPIM
-Granta MI BoM Analytics
 metapackage
 PyTwin
 toolkits

pyproject.toml

@@ -9,9 +9,11 @@ version = "2024.2.dev0"
 description = "Pythonic interfaces to Ansys products"
 readme = "README.rst"
 requires-python = ">=3.9,<4"
-license = {file = "LICENSE"}
-authors = [{name = "ANSYS, Inc.", email = "[email protected]"}]
-maintainers = [{name = "PyAnsys developers", email = "[email protected]"}]
+license = { file = "LICENSE" }
+authors = [{ name = "ANSYS, Inc.", email = "[email protected]" }]
+maintainers = [
+    { name = "PyAnsys developers", email = "[email protected]" },
+]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Science/Research",
@@ -33,8 +35,6 @@ dependencies = [
     "ansys-dyna-core==0.4.5",
     "ansys-dynamicreporting-core==0.5.0",
     "ansys-geometry-core==0.4.4",
-    "ansys-grantami-bomanalytics==1.2.0",
-    "ansys-grantami-recordlists==1.0.0.post1",
     "ansys-fluent-core==0.18.2",
     "ansys-mapdl-core==0.67.0",
     "ansys-math-core==0.1.3",
@@ -50,13 +50,12 @@ dependencies = [
     "ansys-systemcoupling-core==0.3.0",
     "ansys-turbogrid-core==0.4.dev1",
     "pyaedt==0.7.10",
+    "pygranta==2024.1.0",
     "pytwin==0.6.0",
 ]
 
 [project.optional-dependencies]
-mapdl-all = [
-    "ansys-mapdl-reader==0.53.0",
-]
+mapdl-all = ["ansys-mapdl-reader==0.53.0"]
 fluent-all = [
     "ansys-fluent-visualization==0.8.0",
     "ansys-fluent-parametric==0.9.0",
@@ -67,7 +66,7 @@ tools = [
     "pyansys-tools-report==0.7.0",
     "pyansys-tools-versioning==0.5.0",
 ]
-all =  [
+all = [
     # MAPDL - ALL
     "ansys-mapdl-reader==0.53.0",
     # FLUENT - ALL

tools/links.py

@@ -29,8 +29,6 @@
     "ansys-dyna-core": "https://dyna.docs.pyansys.com/version/stable",
     "ansys-dynamicreporting-core": "https://dynamicreporting.docs.pyansys.com/version/stable",  # noqa: E501
     "ansys-geometry-core": "https://geometry.docs.pyansys.com/version/stable",
-    "ansys-grantami-bomanalytics": "https://bomanalytics.grantami.docs.pyansys.com/version/stable",  # noqa: E501
-    "ansys-grantami-recordlists": "https://recordlists.grantami.docs.pyansys.com/version/stable",  # noqa: E501
     "ansys-fluent-core": "https://fluent.docs.pyansys.com/version/stable",
     "ansys-mapdl-core": "https://mapdl.docs.pyansys.com/version/stable",
     "ansys-math-core": "https://math.docs.pyansys.com/version/stable",
@@ -46,6 +44,7 @@
     "ansys-systemcoupling-core": "https://systemcoupling.docs.pyansys.com/version/stable",  # noqa: E501
     "ansys-turbogrid-core": "https://turbogrid.docs.pyansys.com/version/stable",  # noqa: E501
     "pyaedt": "https://aedt.docs.pyansys.com/version/stable",
+    "pygranta": "https://grantami.docs.pyansys.com/version/stable",
     "pytwin": "https://twin.docs.pyansys.com/version/stable",
     # MAPDL - ALL
     "ansys-mapdl-reader": "https://reader.docs.pyansys.com/version/stable",