Migrating techdemos from pymapdl repository

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = *.pyc,*.xml,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac
+quiet-level = 3
+ignore-words-list = pres,nax,tickness,struc,parm

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+exclude = venv, __init__.py, doc/_build, .venv, doc/source/technology_showcase_examples
+select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
+count = True
+max-complexity = 10
+max-line-length = 100
+statistics = True

.github/labeler.yml

@@ -4,5 +4,6 @@ maintenance:
 - .github/**/*
 - .flake8
 - pyproject.toml
+- .codespellrc
 dependencies:
 - requirements/*

.github/workflows/ci_cd.yml

@@ -37,27 +37,27 @@ jobs:
       - name: Test with tox
         run: tox -e style
 
-  docs-style:
-    name: Documentation Style Check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
+  # docs-style:
+  #   name: Documentation Style Check
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
 
-      - name: Running Vale
-        uses: errata-ai/vale-action@reviewdog
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-        with:
-          files: doc
-          reporter: github-pr-check
-          level: error
-          filter_mode: nofilter
-          fail_on_error: true
-          vale_flags: "--config=doc/.vale.ini"
+  #     - name: Running Vale
+  #       uses: errata-ai/vale-action@reviewdog
+  #       env:
+  #         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+  #       with:
+  #         files: doc
+  #         reporter: github-pr-check
+  #         level: error
+  #         filter_mode: nofilter
+  #         fail_on_error: true
+  #         vale_flags: "--config=doc/.vale.ini"
 
   docs:
     name: Documentation
-    needs: [style, docs-style]
+    needs: [style]  #docs-style
     runs-on: ubuntu-latest
     env:
       PYMAPDL_PORT: 21000  # default won't work on GitHub runners
@@ -197,7 +197,7 @@ jobs:
 
   release:
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: [style, docs-style, docs]
+    needs: [style, docs] #docs-style
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.pre-commit-config.yaml

@@ -25,7 +25,6 @@ repos:
   rev: v2.2.2
   hooks:
   - id: codespell
-    args: [--ignore-words=ignore_words.txt, -S \*.pyc\,\*.xml\,\*.txt\,\*.gif\,\*.png\,\*.jpg\,\*.js\,\*.html\,\*.doctree\,\*.ttf\,\*.woff\,\*.woff2\,\*.eot\,\*.mp4\,\*.inv\,\*.pickle\,\*.ipynb\,flycheck\*\,./.git/\*\,./.hypothesis/\*\,\*.yml\,./doc/build/\*\,./doc/images/\*\,./dist/\*\,\*~\,.hypothesis\*\,./doc/source/examples/\*\,\*cover\,\*.dat\,\*.mac]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.3.0

doc/source/conf.py

@@ -12,7 +12,7 @@
 # Select desired logo, theme, and declare the html title
 html_logo = logo
 html_theme = "ansys_sphinx_theme"
-html_short_title = html_title = "pymapdl-techdemos"
+html_short_title = html_title = "PyMAPDL Techdemos"
 
 # specify the location of your github repo
 html_theme_options = {
@@ -21,11 +21,13 @@
     "show_breadcrumbs": True,
     "additional_breadcrumbs": [
         ("PyAnsys", "https://docs.pyansys.com/"),
+        ("PyMAPDL", "https://mapdl.docs.pyansys.com/"),
     ],
 }
 
 # Sphinx extensions
 extensions = [
+    "jupyter_sphinx",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "numpydoc",
@@ -79,3 +81,19 @@
 
 # The master toctree document.
 master_doc = "index"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "links.rst",
+]
+
+# make rst_epilog a variable, so you can add other epilog parts to it
+rst_epilog = ""
+# Read link all targets from file
+with open("links.rst") as f:
+    rst_epilog += f.read()

doc/source/index.rst

@@ -1,6 +1,38 @@
-..
-   Just reuse the root readme to avoid duplicating the documentation.
-   Provide any documentation specific to your online documentation
-   here.
+PyMAPDL Techdemos
+=================
 
-.. include:: ../../README.rst
+The technology showcase examples for `PyMAPDL <pymapdl_docs_>`_ are contained
+in this repository.
+
+Introduction and Purpose
+------------------------
+
+This documentation demonstrates the broad simulation capabilities of Ansys Mechanical
+APDL. The problems demonstrate how to use PyMAPDL to effectively and accurately
+solve interdisciplinary problems from a variety of industries and engineering
+fields.
+
+The exposed files are more complex examples than the ones presented in the `APDL
+Verification Manual <mapdl_vm_>`_. They are complete and concrete case studies
+which necesitate more resources. 
+
+Summary of the exposed Technology Showcase Manual Examples
+----------------------------------------------------------
+
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| Name                       | Description                                                                                             |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`tech_demo_01`        | Technology showcase demonstration example 01: Brake Squeal Analysis.                                    |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`tech_demo_20`        | Technology showcase demonstration example 20: Dynamic simulation of a printed circuit board assembly    |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`tech_demo_28`        | Technology showcase demonstration example 28: Friction Stir Welding (FSW) Simulation                    |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+
+.. === TECHNOLOGY SHOWCASE EXAMPLES ===
+
+.. toctree::
+    :hidden:
+    :maxdepth: 3
+
+    technology_showcase_examples/index

doc/source/links.rst

@@ -0,0 +1,17 @@
+.. #MAPDL related
+.. _mapdl_tech_show: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v222/en/wb_wbtec/wb_wbtec.html
+.. _mapdl_vm: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v222/en/ai_rn/ansys_rn_verif.html
+
+.. #Other projects
+.. _dpf_post_docs: https://post.docs.pyansys.com/
+
+.. #Pyansys
+.. _pyansys: https://docs.pyansys.com
+
+.. #PyMAPDL related
+.. _pymapdl_docs: https://mapdl.docs.pyansys.com
+.. _pymapdl_github: https://github.com/pyansys/pymapdl
+.. _pymapdl_examples: https://mapdl.docs.pyansys.com/examples/index.html
+
+.. # techdemos
+.. _tech_demo_intro: https://ansyshelp.ansys.com/Views/Secured/corp/v212/en/ans_tec/tecintro.html

doc/source/technology_showcase_examples/index.rst

@@ -0,0 +1,19 @@
+.. _ref_technology_showcase_examples:
+
+
+Technology Showcase Manual Examples
+====================================
+
+The  following examples initially come from the `APDL Technology Showcase Manual
+<mapdl_tech_show_>`_. They initially 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
+this project.
+
+.. toctree::
+    :maxdepth: 3
+
+    techdemo-1/ex_0-tecbrakesqueal
+    techdemo-20/ex_20-tecPCB
+    techdemo-28/ex_28-tecfricstir