Connect with docker session in examples

.ci/start_fluent.py

@@ -0,0 +1,42 @@
+import os
+import subprocess
+import sys
+import tempfile
+import time
+
+from ansys.fluent.core import EXAMPLES_PATH
+
+
+def start_fluent_container(args):
+    fd, sifile = tempfile.mkstemp(
+        suffix=".txt", prefix="serverinfo-", dir=EXAMPLES_PATH
+    )
+    os.close(fd)
+    timeout = 100
+    license_server = os.environ["ANSYSLMD_LICENSE_FILE"]
+    port = os.environ["PYFLUENT_FLUENT_PORT"]
+
+    subprocess.run(["docker", "run", "--name", "fluent_server", "-d", "--rm",
+                    "-p", f"{port}:{port}",
+                    "-v", f"{EXAMPLES_PATH}:{EXAMPLES_PATH}",
+                    "-e", f"ANSYSLMD_LICENSE_FILE={license_server}",
+                    "-e", f"REMOTING_PORTS={port}/portspan=2",
+                    "-e", "FLUENT_LAUNCHED_FROM_PYFLUENT=1",
+                    "ghcr.io/pyansys/pyfluent",
+                    "-g", f"-sifile={sifile}"] + args)
+
+    sifile_last_mtime = os.stat(sifile).st_mtime
+    while True:
+        if os.stat(sifile).st_mtime > sifile_last_mtime:
+            time.sleep(1)
+            break
+        if timeout == 0:
+            break
+        time.sleep(1)
+        timeout -= 1
+    if os.path.exists(sifile):
+        os.remove(sifile)
+
+
+if __name__ == "__main__":
+    start_fluent_container(sys.argv[1:])

.ci/stop_fluent.py

@@ -0,0 +1,9 @@
+import subprocess
+
+
+def stop_fluent_container():
+    subprocess.run(["docker", "stop", "fluent_server"])
+
+
+if __name__ == "__main__":
+    stop_fluent_container()

.github/workflows/ci.yml

@@ -10,6 +10,10 @@ on:
     branches:
       - main
 
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   stylecheck:
     name: Style Check
@@ -119,12 +123,25 @@ jobs:
       - name: Install pyfluent with post module
         run: make install-post
 
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ secrets.GH_USERNAME }}
+          password: ${{ secrets.REPO_DOWNLOAD_PAT }}
+
+      - name: Pull Fluent docker image
+        run: make docker-pull
+
       - name: Build Documentation
         run: |
           pip install -r requirements_docs.txt
           make -C doc html
           touch doc/_build/html/.nojekyll
           echo "fluentdocs.pyansys.com" >> doc/_build/html/CNAME
+        env:
+          ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
+          PYFLUENT_FLUENT_PORT: 63084
 
       - name: Upload HTML Documentation
         uses: actions/upload-artifact@v2

.github/workflows/nightly-doc-build.yml

@@ -33,12 +33,25 @@ jobs:
       - name: Install pyfluent with post module
         run: make install-post
 
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ secrets.GH_USERNAME }}
+          password: ${{ secrets.REPO_DOWNLOAD_PAT }}
+
+      - name: Pull Fluent docker image
+        run: make docker-pull
+
       - name: Build Documentation
         run: |
           pip install -r requirements_docs.txt
           make -C doc html
           touch doc/_build/html/.nojekyll
           echo "dev.fluentdocs.pyansys.com" >> doc/_build/html/CNAME
+        env:
+          ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
+          PYFLUENT_FLUENT_PORT: 63084
 
       - name: Deploy
         uses: JamesIves/[email protected]

Makefile

@@ -18,6 +18,9 @@ install-pyvistaqt-requirements:
 	@sudo apt-get update
 	@sudo apt-get install libegl1 -y
 
+docker-pull:
+	@docker pull ghcr.io/pyansys/pyfluent:latest
+
 test-import:
 	@python -c "import ansys.fluent.core as pyfluent"
 

doc/source/conf.py

@@ -1,5 +1,8 @@
 """Sphinx documentation configuration file."""
 from datetime import datetime
+import os
+import subprocess
+import sys
 
 from pyansys_sphinx_theme import pyansys_logo_black
 from sphinx_gallery.sorting import FileNameSortKey
@@ -93,6 +96,25 @@
 copybutton_prompt_is_regexp = True
 
 
+_THIS_DIR = os.path.dirname(__file__)
+_START_FLUENT_FILE = os.path.normpath(
+    os.path.join(_THIS_DIR, "..", "..", ".ci", "start_fluent.py")
+)
+_STOP_FLUENT_FILE = os.path.normpath(
+    os.path.join(_THIS_DIR, "..", "..", ".ci", "stop_fluent.py")
+)
+
+
+def _start_or_stop_fluent_container(gallery_conf, fname, when):
+    if when == "before":
+        if fname in ["mixing_elbow_settings_api.py",
+                     "mixing_elbow_tui_api.py"]:
+            args = ["3ddp", "-t4", "-meshing"]
+        subprocess.run([sys.executable, _START_FLUENT_FILE] + args)
+    elif when == "after":
+        subprocess.run([sys.executable, _STOP_FLUENT_FILE])
+
+
 # -- Sphinx Gallery Options ---------------------------------------------------
 sphinx_gallery_conf = {
     # convert rst to md for ipynb
@@ -113,6 +135,8 @@
     "doc_module": "ansys-fluent-core",
     "ignore_pattern": "flycheck*",
     "thumbnail_size": (350, 350),
+    'reset_modules_order': 'both',
+    'reset_modules': (_start_or_stop_fluent_container),
 }