Adding TechDemo 25: Cardiovascular Stent Simulation

.github/workflows/ci_cd.yml

@@ -119,7 +119,7 @@ jobs:
 
       - name: Build Documentation
         run: |
-          xvfb-run make -C doc html SPHINXOPTS="-j auto -W --keep-going"
+          xvfb-run make -C doc html SPHINXOPTS="-j auto --keep-going"
 
       - name: Upload HTML Documentation
         uses: actions/upload-artifact@v3

.gitignore

@@ -148,6 +148,9 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# Visual studio code local settings
+.vscode/
+
 # PyCharm
 #  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

doc/source/conf.py

@@ -1,16 +1,24 @@
 """Sphinx documentation configuration file."""
 from datetime import datetime
+import warnings
 
-from ansys_sphinx_theme import pyansys_logo_black as logo
+from ansys_sphinx_theme import ansys_favicon, pyansys_logo_black
+import pyvista
+
+# Ensure that offscreen rendering is used for docs generation
+pyvista.OFF_SCREEN = True
 
 # Project information
 project = "pymapdl-examples"
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "ANSYS, Inc."
 release = version = "0.1.dev0"
 
+# Favicon
+html_favicon = ansys_favicon
+
 # Select desired logo, theme, and declare the html title
-html_logo = logo
+html_logo = pyansys_logo_black
 html_theme = "ansys_sphinx_theme"
 html_short_title = html_title = "PyMAPDL Examples"
 
@@ -19,10 +27,12 @@
     "github_url": "https://github.com/pyansys/pymapdl-examples",
     "show_prev_next": False,
     "show_breadcrumbs": True,
+    "collapse_navigation": True,
+    "use_edit_page_button": True,
     "additional_breadcrumbs": [
         ("PyAnsys", "https://docs.pyansys.com/"),
         ("PyMAPDL", "https://mapdl.docs.pyansys.com/"),
-        ("Examples", "https://mapdl.docs.pyansys.com/examples/"),
+        ("Examples", "https://mapdl.docs.pyansys.com/dev/examples/"),
     ],
     "icon_links": [
         {
@@ -33,6 +43,14 @@
     ],
 }
 
+html_context = {
+    "display_github": True,  # Integrate GitHub
+    "github_user": "pyansys",
+    "github_repo": "pymapdl-example",
+    "github_version": "main",
+    "doc_path": "doc/source",
+}
+
 # Sphinx extensions
 extensions = [
     "jupyter_sphinx",
@@ -56,7 +74,7 @@
     # path to your examples scripts
     "examples_dirs": [],
     # path where to save gallery generated examples
-    "gallery_dirs": ["verif-manual", "technology_showcase_examples"],
+    "gallery_dirs": [""],
     # Pattern to search for example files
     "filename_pattern": r"\.py",
     # Remove the "Download all examples" button from the top level gallery
@@ -73,15 +91,21 @@
 # Intersphinx mapping
 intersphinx_mapping = {
     "python": ("https://docs.python.org/dev", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
+    "numpy": ("https://numpy.org/devdocs", None),
+    "matplotlib": ("https://matplotlib.org/stable", None),
+    "pyvista": ("https://docs.pyvista.org/", None),
     # kept here as an example
-    # "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
-    # "numpy": ("https://numpy.org/devdocs", None),
-    # "matplotlib": ("https://matplotlib.org/stable", None),
     # "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
-    # "pyvista": ("https://docs.pyvista.org/", None),
     # "grpc": ("https://grpc.github.io/grpc/python/", None),
 }
 
+# suppress annoying matplotlib bug
+warnings.filterwarnings("ignore")
+
+suppress_warnings = ["label.*"]
+# supress_warnings = ["ref.option"]
+
 # numpydoc configuration
 numpydoc_show_class_members = False
 numpydoc_xref_param_type = True

doc/source/index.rst

@@ -231,6 +231,8 @@ which necesitate more resources.
 
     <div class="sphx-glr-thumbnails">
 
+.. #########
+
 .. raw:: html
 
     <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 01: Brake Squeal Analysis">
@@ -240,13 +242,33 @@ which necesitate more resources.
   .. image:: technology_showcase_examples/images/thumb/sphx_glr_tse-001-brake_squeal_thumb.png
     :alt: Brake Squeal Analysis
 
-  :ref:`sphx_glr_ex_0-tecbrakesqueal.py`
+  :ref:`sphx_glr_ex_0-tecbrakesqueal.rst`
 
 .. raw:: html
 
       <div class="sphx-glr-thumbnail-title">Brake Squeal Analysis</div>
     </div>
 
+.. ##########
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase Example 15: Calibrating and Validating a Hyperelastic Constitutive Model">
+
+.. only:: html
+
+  .. image:: technology_showcase_examples/images/thumb/sphx_glr_tse-015-calvalhyper_thumb.gif
+    :alt: Calibrating and Validating a Hyperelastic Constitutive Model
+
+  :ref:`sphx_glr_ex_15-teccalvalhyper.rst`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Calibrating and Validating a Hyperelastic Constitutive Model</div>
+    </div>
+
+.. #########
+
 .. raw:: html
 
     <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 20: Dynamic simulation of a printed circuit board assembly">
@@ -256,13 +278,32 @@ which necesitate more resources.
   .. image:: technology_showcase_examples/images/thumb/sphx_glr_tse-020-PCB_thumb.png
     :alt: Dynamic simulation of a printed circuit board assembly
 
-  :ref:`sphx_glr_ex_20-tecPCB.py`
+  :ref:`sphx_glr_ex_20-tecPCB.rst`
 
 .. raw:: html
 
       <div class="sphx-glr-thumbnail-title">Dynamic simulation of a printed circuit board assembly</div>
     </div>
 
+.. #########
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 25: Cardiovascular Stent Simulation">
+
+.. only:: html
+
+  .. image:: technology_showcase_examples/images/thumb/sphx_glr_tse-025-stent_thumb.png
+    :alt: Cardiovascular Stent Simulation
+
+  :ref:`sphx_glr_ex_25-tecstent.rst`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Cardiovascular Stent Simulation</div>
+    </div>
+
+.. #########
 
 .. raw:: html
 
@@ -273,16 +314,13 @@ which necesitate more resources.
   .. image:: technology_showcase_examples/images/thumb/sphx_glr_tse-028-fricstir_thumb.png
     :alt: Friction Stir Welding (FSW) Simulation
 
-  :ref:`sphx_glr_ex_28-tecfricstir.py`
+  :ref:`sphx_glr_ex_28-tecfricstir.rst`
 
 .. raw:: html
 
       <div class="sphx-glr-thumbnail-title">Friction Stir Welding (FSW) Simulation</div>
     </div>
 
-.. raw:: html
-
-    </div>
 
 .. === TECHNOLOGY SHOWCASES ===
 

doc/source/links.rst

@@ -1,5 +1,5 @@
 .. #MAPDL related
-.. _mapdl_tech_show: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v222/en/wb_wbtec/wb_wbtec.html
+.. _mapdl_tech_show: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v222/en/ans_tec/ans_tec.html
 .. _mapdl_vm: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v222/en/ai_rn/ansys_rn_verif.html
 
 .. #Other projects

doc/source/technology_showcase_examples/index.rst

@@ -4,7 +4,7 @@ Technology Showcases
 ====================
 
 The  following examples initially come from the `APDL Technology Showcase Manual
-<mapdl_tech_show_>`_. They initially were MAPDL files. They have been reproduced
+<mapdl_tech_show_>`_. Originally, they were MAPDL files. They have been reproduced
 in Python files using PyMAPDL with the ``ansys-mapdl-core`` library.
 
 These examples are a work-in-progress and will be extended during the life of
@@ -16,6 +16,8 @@ this project.
 
     <div class="sphx-glr-thumbnails">
 
+.. #########
+
 .. raw:: html
 
     <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 01: Brake Squeal Analysis">
@@ -25,81 +27,93 @@ this project.
   .. image:: images/thumb/sphx_glr_tse-001-brake_squeal_thumb.png
     :alt: Brake Squeal Analysis
 
-  :ref:`sphx_glr_ex_0-tecbrakesqueal.py`
+  :ref:`sphx_glr_ex_0-tecbrakesqueal.rst`
 
 .. raw:: html
 
       <div class="sphx-glr-thumbnail-title">Brake Squeal Analysis</div>
     </div>
 
+.. ##########
+
 .. raw:: html
 
-    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 20: Dynamic simulation of a printed circuit board assembly">
+    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase Example 15: Calibrating and Validating a Hyperelastic Constitutive Model">
 
 .. only:: html
 
-  .. image:: images/thumb/sphx_glr_tse-020-PCB_thumb.png
-    :alt: Dynamic simulation of a printed circuit board assembly
-
-  :ref:`sphx_glr_ex_20-tecPCB.py`
+  .. image:: images/thumb/sphx_glr_tse-015-calvalhyper_thumb.gif
+    :alt: Calibrating and Validating a Hyperelastic Constitutive Model
+  
+  :ref:`sphx_glr_ex_15-teccalvalhyper.rst`
 
 .. raw:: html
 
-      <div class="sphx-glr-thumbnail-title">Dynamic simulation of a printed circuit board assembly</div>
+      <div class="sphx-glr-thumbnail-title">Calibrating and Validating a Hyperelastic Constitutive Model</div>
     </div>
 
+.. #########
 
 .. raw:: html
 
-    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 28: Friction Stir Welding (FSW) Simulation">
+    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 20: Dynamic simulation of a printed circuit board assembly">
 
 .. only:: html
 
-  .. image:: images/thumb/sphx_glr_tse-028-fricstir_thumb.png
-    :alt: Friction Stir Welding (FSW) Simulation
+  .. image:: images/thumb/sphx_glr_tse-020-PCB_thumb.png
+    :alt: Dynamic simulation of a printed circuit board assembly
 
-  :ref:`sphx_glr_ex_28-tecfricstir.py`
+  :ref:`sphx_glr_ex_20-tecPCB.rst`
 
 .. raw:: html
 
-      <div class="sphx-glr-thumbnail-title">Friction Stir Welding (FSW) Simulation</div>
+      <div class="sphx-glr-thumbnail-title">Dynamic simulation of a printed circuit board assembly</div>
     </div>
 
+.. #########
+
 .. raw:: html
 
-    </div>
+    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 25: Cardiovascular Stent Simulation">
 
+.. only:: html
 
-.. ##########
+  .. image:: images/thumb/sphx_glr_tse-025-stent_thumb.png
+    :alt: Cardiovascular Stent Simulation
 
+  :ref:`sphx_glr_ex_25-tecstent.rst`
 
 .. raw:: html
 
-    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase Example 15: Calibrating and Validating a Hyperelastic Constitutive Model">
-
-.. only:: html
+      <div class="sphx-glr-thumbnail-title">Cardiovascular Stent Simulation</div>
+    </div>
 
-  .. image:: images/thumb/sphx_glr_tse-015-calvalhyper_thumb.gif
-    :alt: Calibrating and Validating a Hyperelastic Constitutive Model
+.. #########
 
 .. raw:: html
 
-      <div class="sphx-glr-thumbnail-title">Calibrating and Validating a Hyperelastic Constitutive Model</div>
-    </div>
+    <div class="sphx-glr-thumbcontainer" tooltip="Technology Showcase demonstration Example 28: Friction Stir Welding (FSW) Simulation">
+
+.. only:: html
+
+  .. image:: images/thumb/sphx_glr_tse-028-fricstir_thumb.png
+    :alt: Friction Stir Welding (FSW) Simulation
+
+  :ref:`sphx_glr_ex_28-tecfricstir.rst`
 
 .. raw:: html
 
+      <div class="sphx-glr-thumbnail-title">Friction Stir Welding (FSW) Simulation</div>
     </div>
 
-.. #########
-
 .. toctree::
     :hidden:
     :includehidden:
 
     techdemo-1/ex_0-tecbrakesqueal
-    techdemo-15/ex-15-teccalvalhyper
+    techdemo-15/ex_15-teccalvalhyper
     techdemo-20/ex_20-tecPCB
+    techdemo-25/ex_25-tecstent
     techdemo-28/ex_28-tecfricstir
 
 .. only:: html

doc/source/technology_showcase_examples/techdemo-1/ex_0-tecbrakesqueal.rst

@@ -1,4 +1,4 @@
-.. _sphx_glr_ex_0-tecbrakesqueal.py:
+.. _sphx_glr_ex_0-tecbrakesqueal.rst:
 
 .. _tech_demo_01:
 

doc/source/technology_showcase_examples/techdemo-15/ex-15-teccalvalhyper.rst → doc/source/technology_showcase_examples/techdemo-15/ex_15-teccalvalhyper.rst

@@ -1,5 +1,7 @@
-Technology Showcase Example 15: Calibrating and Validating a Hyperelastic Constitutive Model
-----------------------------------------------------------------------------------------------
+.. _sphx_glr_ex_15-teccalvalhyper.rst:
+
+Calibrating and Validating a Hyperelastic Constitutive Model
+------------------------------------------------------------
 
 This example problem demonstrates the hyperelastic curve-fitting capabilities used to select constitutive model
 parameters to fit experimental data. Several issues that influence the accuracy of the curve fit are discussed.