Adding a webApp example using Dash (#1497)

* Adding a webApp example using Dash

* Fixing style.

* Reformatting example to just add the zip.

* Fix doc build issues.

* Resetting cache

Co-authored-by: German <[email protected]>

Author: rs-bh-n

.github/workflows/ci.yml

@@ -26,10 +26,10 @@ env:
   # You should go up in number, if you go down (or repeat a previous value)
   # you might end up reusing a previous cache if it haven't been deleted already.
   # It applies 7 days retention policy by default.
-  RESET_PIP_CACHE: 2
-  RESET_EXAMPLES_CACHE: 2
-  RESET_DOC_BUILD_CACHE: 2
-  RESET_AUTOSUMMARY_CACHE: 2
+  RESET_PIP_CACHE: 3
+  RESET_EXAMPLES_CACHE: 3
+  RESET_DOC_BUILD_CACHE: 3
+  RESET_AUTOSUMMARY_CACHE: 3
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

doc/source/examples/extended_examples/dash/dash-vm35.zip

@@ -0,0 +1,39 @@
+.. _dash_example:
+
+Use Dash to build a PyMAPDL web app
+===================================
+
+This example shows how to use Dash to build a web app for a simple FEA problem.
+
+Dash is a low-code framework for building data apps which are rendered in a web browser. 
+For Dash documentation, refer to: https://dash.plotly.com/
+
+
+Required modules
+----------------
+
+For this example, install modules as needed:
+
+* ``dash``
+* ``dash_bootstrap_components``
+* ``plotly.express``
+* ``webbrowser``
+* ``pandas``
+
+Structure
+---------
+
+* Description page. Read the problem statement 
+* Simulation Page. 
+  Allow to change the input values, solve the problem and plot the results.
+* Data Page : 
+	Allow to plot data in a table and graph
+
+
+Usage
+-----
+
+Download the zip file from the link below and unzip it to a folder.
+Run the Python file ``BimetallicStrip.py`` which launches the app in your default browser.
+
+:download:`ANSYS Licensing Guide <dash-vm35.zip>`

doc/source/examples/extended_examples/dash/dash_example.rst

@@ -18,5 +18,8 @@ with other programs, libraries, and features in development.
 +----------------------------+---------------------------------------------------------------------------------------------------------+
 | :ref:`krylov_example`      | Demonstrates the usage of the Krylov method for solving a customized harmonic analysis.                 |
 +----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`dash_example`        | Demonstrates the use of PyMAPDL with Dash.                                                              |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+
 
 .. _Cart-Pole Simulation: https://pyansys.github.io/ml-rl-cartpole/ml-rl-notebook.html

doc/source/examples/extended_examples/index.rst

@@ -46,6 +46,7 @@ The documentation to the exposed examples can be found in the
     extended_examples/ex_01-gmsh_example/ex_01-gmsh_example
     extended_examples/Python_UPF/python_upf_examples
     extended_examples/Krylov/krylov_example
+    extended_examples/dash/dash_example
 
 .. include:: extended_examples/index.rst
    :start-line: 2

doc/source/examples/index.rst

@@ -14,11 +14,11 @@ Resources
   These are versions valid during a year and with limited capabilities 
   regarding number of nodes, elements, etc.
 
-- View and download `PyMAPDL cheatsheet <pymapdl_cheatsheet_>`_.
+- View and download `PyMAPDL cheatsheet <pymapdl_cheatsheet_>`.
 
 
 Courses
-=======
+===============
 
 Ansys has prepared high quality courses to guide you through the learning process.