build: Bump version 0.24.0 (#618)

Added pyfluent dependency version 0.37.0 which contains the secure grpc
options. There is no source code change, only the CIs have been updated
to generate and use certificates.

Author: mkundu1

.ci/pull_fluent_image.sh

@@ -1,10 +1,10 @@
 #!/bin/sh
 
 # Image name
-_IMAGE_NAME="ghcr.io/ansys/pyfluent:${FLUENT_IMAGE_TAG:-latest}"
+_IMAGE_NAME="ghcr.io/ansys/fluent:${FLUENT_IMAGE_TAG:-latest}"
 
 # Pull fluent image based on tag
 docker pull $_IMAGE_NAME
 
 # Remove all dangling images
-docker image prune -f
+docker image prune -f

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-exclude = venv, __init__.py, doc/_build, .venv
+exclude = venv, __init__.py, doc/_build, .venv, tests/generate_certs.py
 select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
 count = True
 max-complexity = 10

.github/workflows/ci_cd.yml

@@ -25,8 +25,9 @@ env:
   ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
   MAIN_PYTHON_VERSION: "3.11"
   LIBRARY_NAME: 'ansys-fluent-visualization'
-  PYFLUENT_TIMEOUT_FORCE_EXIT: 5
+  PYFLUENT_TIMEOUT_FORCE_EXIT: 60
   PYFLUENT_LAUNCH_CONTAINER: 1
+  PYFLUENT_LAUNCH_FLUENT_TIMEOUT: 60
 
 jobs:
 
@@ -104,12 +105,12 @@ jobs:
         if:  matrix.os == 'public-ubuntu-latest-8-cores'
         run: make docker-pull
         env:
-          FLUENT_IMAGE_TAG: v25.2.0
+          FLUENT_IMAGE_TAG: v25.2.3
 
       - name: Test with pytest
         run: make unittest
         env:
-          FLUENT_IMAGE_TAG: v25.2.0
+          FLUENT_IMAGE_TAG: v25.2.3
 
       - name: Upload 25.2 Coverage Artifacts
         if: matrix.os == 'windows-latest' && matrix.python-version == '3.12'
@@ -118,7 +119,7 @@ jobs:
           name: coverage_report
           path: ./htmlcov
         env:
-          FLUENT_IMAGE_TAG: v25.2.0
+          FLUENT_IMAGE_TAG: v25.2.3
 
       - name: Remove all docker images
         if: always()
@@ -132,7 +133,7 @@ jobs:
       contents: read
       packages: read
     env:
-      DOC_DEPLOYMENT_IMAGE_TAG: v25.2.0
+      DOC_DEPLOYMENT_IMAGE_TAG: v25.2.3
       DOCUMENTATION_CNAME: "visualization.fluent.docs.pyansys.com"
       XDG_RUNTIME_DIR: /tmp/runtime-${{ github.run_id }}
 
@@ -227,7 +228,7 @@ jobs:
     permissions:
       contents: write
     env:
-      DOC_DEPLOYMENT_IMAGE_TAG: v25.2.0
+      DOC_DEPLOYMENT_IMAGE_TAG: v25.2.3
     needs: [ docs ]
     steps:
       - name: "Deploy the stable documentation"

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

@@ -12,9 +12,10 @@ permissions:
 env:
   DOCUMENTATION_CNAME: 'visualization.fluent.docs.pyansys.com'
   MAIN_PYTHON_VERSION: '3.11'
-  DOC_DEPLOYMENT_IMAGE_TAG: v25.2.0
+  DOC_DEPLOYMENT_IMAGE_TAG: v25.2.3
   ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
-  PYFLUENT_TIMEOUT_FORCE_EXIT: 5
+  PYFLUENT_TIMEOUT_FORCE_EXIT: 60
+  PYFLUENT_LAUNCH_FLUENT_TIMEOUT: 60
   PYFLUENT_LAUNCH_CONTAINER: 1
   XDG_RUNTIME_DIR: /tmp/runtime-${{ github.run_id }}
 

.github/workflows/nightly-test-run.yml

@@ -54,12 +54,12 @@ jobs:
         if: matrix.os == 'public-ubuntu-latest-8-cores'
         run: make docker-pull
         env:
-          FLUENT_IMAGE_TAG: v25.2.0
+          FLUENT_IMAGE_TAG: v25.2.3
 
       - name: Test with pytest
         run: make unittest
         env:
-          FLUENT_IMAGE_TAG: v25.2.0
+          FLUENT_IMAGE_TAG: v25.2.3
 
       - name: Remove all docker images
         if: always()

Makefile

@@ -17,12 +17,16 @@ docker-pull:
 
 unittest:
 	@pip install -r requirements/requirements_tests.txt
+	@pip install cryptography==45.0.7
+	@python tests/generate_certs.py
 	@pytest -v --cov=ansys.fluent --cov-report=xml:cov_xml.xml --cov-report=html
 
 build-doc:
 	@sudo rm -rf /home/ansys/.local/share/ansys_fluent_core/examples/*
 	@pip install -r requirements/requirements_doc.txt
+	@pip install cryptography==45.0.7
 	@python doc/api_rstgen.py
+	@python tests/generate_certs.py
 	@xvfb-run make -C doc html
 	@touch doc/_build/html/.nojekyll
 	@echo "$(DOCS_CNAME)" >> doc/_build/html/CNAME

doc/source/conf.py

@@ -2,11 +2,14 @@
 
 from datetime import datetime
 import os
+from pathlib import Path
 import platform
+import shutil
 import subprocess
 import sys
 
 import ansys.fluent.core as pyfluent
+from ansys.fluent.core.docker.utils import get_grpc_launcher_args_for_gh_runs
 from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_black
 import numpy as np
 import pyvista
@@ -135,21 +138,33 @@
 copybutton_prompt_is_regexp = True
 
 
-def _stop_fluent_container(gallery_conf, fname):
-    try:
-        is_linux = platform.system() == "Linux"
-        container_names = (
-            subprocess.check_output(
-                "docker container ls --format {{.Names}}", shell=is_linux
+def _reset_modules_hook(gallery_conf, fname, when):
+    if when == "before":
+        # Absolute path to doc/source/
+        doc_src = Path(gallery_conf["src_dir"])
+        # Project root = parent of the examples_root
+        project_root = doc_src.parent.parent
+        # Source = top-level project directory / certs
+        source = project_root / "certs"
+        # Destination = directory of the example file / certs
+        destination = project_root / "examples" / "00-post_processing" / "certs"
+        print(f"Copying certs from {source} to {destination}")
+        shutil.copytree(source, destination, dirs_exist_ok=True)
+    elif when == "after":
+        try:
+            is_linux = platform.system() == "Linux"
+            container_names = (
+                subprocess.check_output(
+                    "docker container ls --format {{.Names}}", shell=is_linux
+                )
+                .decode("utf-8")
+                .strip()
+                .split()
             )
-            .decode("utf-8")
-            .strip()
-            .split()
-        )
-        for container_name in container_names:
-            subprocess.run(f"docker stop {container_name}", shell=is_linux)
-    except Exception:
-        pass
+            for container_name in container_names:
+                subprocess.run(f"docker stop {container_name}", shell=is_linux)
+        except Exception:
+            pass
 
 
 # -- Sphinx Gallery Options ---------------------------------------------------
@@ -176,8 +191,8 @@ def _stop_fluent_container(gallery_conf, fname):
     "doc_module": "ansys-fluent-core",
     "image_scrapers": ("pyvista", "matplotlib"),
     "thumbnail_size": (350, 350),
-    "reset_modules_order": "after",
-    "reset_modules": (_stop_fluent_container,),
+    "reset_modules_order": "both",
+    "reset_modules": (_reset_modules_hook,),
 }
 
 
@@ -288,3 +303,19 @@ def _stop_fluent_container(gallery_conf, fname):
 
 # PyAnsys tags configuration
 html_context = {"pyansys_tags": ["Fluids"]}
+
+
+# TODO: Remove this workaround when a cleaner solution to override
+# pyfluent launch args is available.
+
+launch_fluent_original = pyfluent.launch_fluent
+
+
+def launch_fluent_secure(*args, **kwargs):
+    """Launch Fluent in secure mode for documentation generation."""
+    kwargs.update(get_grpc_launcher_args_for_gh_runs())
+    return launch_fluent_original(*args, **kwargs)
+
+
+if "FLUENT_IMAGE_TAG" in os.environ:
+    pyfluent.launch_fluent = launch_fluent_secure

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 # Check https://python-poetry.org/docs/pyproject/ for all available sections
 name = "ansys-fluent-visualization"
-version = "0.24.dev0"
+version = "0.24.0"
 description = "A python wrapper for ansys Fluent visualization"
 license = "MIT"
 authors = ["ANSYS, Inc. <[email protected]>"]
@@ -25,7 +25,7 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.10,<3.14"
 importlib-metadata = {version = "^4.0", python = "<3.9"}
-ansys-fluent-core = "~=0.37.dev0"
+ansys-fluent-core = "~=0.37.0"
 pyvista = ">=0.44.0"
 matplotlib = ">=3.6.0"
 pyvistaqt = { version = "~=0.11.1", optional = true }

requirements/requirements_doc.txt

@@ -16,4 +16,4 @@ autodocsumm==0.2.14
 pyvista[trame]>=0.43.3
 matplotlib>=3.8.3
 quarto-cli==1.5.57
-pdf2image==1.17.0
+pdf2image==1.17.0