feat: adding PySherlock (#287)

* feat: adding PySherlock

* fix: solving errors

* feat: adding custom image

Author: RobPasMue

.github/workflows/create-milestone.yml

@@ -32,6 +32,7 @@ jobs:
             "ansys/grantami-recordlist",
             "ansys/openapi-common",
             "ansys/pyseascape",
+            "ansys/pysherlock",
             "ansys/pyprimemesh",
             "ansys/pytwin",
             "ansys/pysystem-coupling",

README.rst

@@ -52,6 +52,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 - `PyPIM <https://pypim.docs.pyansys.com/>`_: Pythonic interface to communicate with the Ansys PIM (Product Instance Management) API.
 - `PyPrimeMesh <https://prime.docs.pyansys.com>`_: Pythonic interface to Ansys Prime Server, which delivers core Ansys meshing technology.
 - `PySeascape <https://seascape.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys RedHawkSC and TotemSC.
+- `PySherlock <https://sherlock.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys Sherlock.
 - `PySystemCoupling <https://systemcoupling.docs.pyansys.com/>`_: Pythonic interface to communicate with Ansys System Coupling.
 - `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.
@@ -78,6 +79,7 @@ By default, the PyAnsys metapackage installs these core modules:
 - `PyPIM`_
 - `PyPrimeMesh`_
 - `PySeascape`_
+- `PySherlock`_
 - `PySystemCoupling`_
 - `PyTwin`_
 - `Granta MI BoM Analytics`_

doc/source/_static/thumbnails/pysherlock.png

@@ -116,6 +116,12 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PySherlock
+      :img-top: _static/thumbnails/pysherlock.png
+      :link: https://sherlock.docs.pyansys.com/version/stable/api/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PySystemCoupling
       :img-top: _static/thumbnails/pysystem-coupling.png
       :link: https://systemcoupling.docs.pyansys.com/version/0.1/api/index.html

doc/source/api.rst

@@ -105,6 +105,12 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PySherlock
+      :img-top: _static/thumbnails/pysherlock.png
+      :link: https://sherlock.docs.pyansys.com/version/stable/getting_started/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PySystemCoupling
       :img-top: _static/thumbnails/pysystem-coupling.png
       :link: https://systemcoupling.docs.pyansys.com/version/0.1/examples/index.html

doc/source/examples.rst

@@ -144,6 +144,14 @@ it is now a collection of many Python packages for using Ansys products through
 
       Pythonic interface to communicate with Ansys RedHawkSC and TotemSC
 
+    .. grid-item-card:: PySherlock
+      :img-top: _static/thumbnails/pysherlock.png
+      :link: https://sherlock.docs.pyansys.com/version/stable
+      :text-align: center
+      :class-title: pyansys-card-title
+
+      Pythonic interface to communicate with Ansys Sherlock
+
     .. grid-item-card:: PySystem Coupling
       :img-top: _static/thumbnails/pysystem-coupling.png
       :link: https://systemcoupling.docs.pyansys.com/version/0.1

doc/source/index.rst

@@ -108,6 +108,12 @@ PyAnsys packages user guides
       :text-align: center
       :class-title: pyansys-card-title
 
+    .. grid-item-card:: PySherlock
+      :img-top: _static/thumbnails/pysherlock.png
+      :link: https://sherlock.docs.pyansys.com/version/stable/user_guide/index.html
+      :text-align: center
+      :class-title: pyansys-card-title
+
     .. grid-item-card:: PySystemCoupling
       :img-top: _static/thumbnails/pysystem-coupling.png
       :link: https://systemcoupling.docs.pyansys.com/version/0.1/users_guide/index.html

doc/source/user_guide.rst

@@ -38,6 +38,7 @@ dependencies = [
     "ansys-grantami-recordlists==1.0.0",
     "ansys-openapi-common==1.2.1",
     "ansys-seascape==0.2.0",
+    "ansys-sherlock-core==0.2.0",
     "ansys-meshing-prime==0.3.2",
     "pytwin==0.3.0",
     "ansys-systemcoupling-core==0.1.3",