Feat/dm new api prints

.ci/fluent_test_runner.py

@@ -1,6 +1,7 @@
 """Script to run Fluent test in Docker container."""
 
 import argparse
+import concurrent.futures
 import logging
 import os
 from pathlib import Path
@@ -21,10 +22,10 @@ class FluentRuntimeError(RuntimeError):
     pass
 
 
-def run_fluent_test(
-    src_test_dir: Path, journal_file: Path, launcher_args: str = ""
+def _run_single_test(
+    src_test_dir: Path, journal_file: Path, launcher_args: str
 ) -> None:
-    """Run Fluent test.
+    """Run a single Fluent test.
 
     Parameters
     ----------
@@ -103,13 +104,29 @@ def run_fluent_test(
             sleep(1)
         logging.debug(container.logs(stderr=True).decode())
         container.remove()
-    except docker.errors.NotFound:
+    except docker.errors.DockerException:
         pass
 
 
 MAX_TEST_PATH_LENGTH = 100
 
 
+def _run_single_test_with_status_print(
+    src_test_dir: Path, journal_file: Path, launcher_args: str, test_file_relpath: str
+) -> bool:
+    try:
+        _run_single_test(src_test_dir, journal_file, launcher_args)
+        print(
+            f"{test_file_relpath}{(MAX_TEST_PATH_LENGTH + 10 - len(test_file_relpath)) * '·'}PASSED"
+        )
+    except FluentRuntimeError as e:
+        print(
+            f"{test_file_relpath}{(MAX_TEST_PATH_LENGTH + 10 - len(test_file_relpath)) * '·'}FAILED"
+        )
+        print(e)
+        return True
+
+
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(description="Run Fluent test.")
     parser.add_argument(
@@ -120,7 +137,8 @@ def run_fluent_test(
     test_dir = Path.cwd() / args.test_dir
     with TemporaryDirectory(ignore_cleanup_errors=True) as src_test_dir:
         copytree(test_dir, src_test_dir, dirs_exist_ok=True)
-        exception_occurred = False
+        statuses = []
+        arguments = []
         src_test_dir = Path(src_test_dir)
         for test_file in (src_test_dir / "fluent").rglob("*.py"):
             config_file = test_file.with_suffix(".yaml")
@@ -129,17 +147,22 @@ def run_fluent_test(
                 configs = yaml.safe_load(config_file.read_text())
                 launcher_args = configs.get("launcher_args", "")
             test_file_relpath = str(test_file.relative_to(src_test_dir))
-            print(f"Running {test_file_relpath}", end="", flush=True)
-            try:
-                run_fluent_test(src_test_dir, test_file, launcher_args)
-                print(
-                    f"{(MAX_TEST_PATH_LENGTH + 10 - len(test_file_relpath)) * '·'}PASSED"
-                )
-            except FluentRuntimeError as e:
-                print(
-                    f"{(MAX_TEST_PATH_LENGTH + 10 - len(test_file_relpath)) * '·'}FAILED"
-                )
-                print(e)
-                exception_occurred = True
-        if exception_occurred:
+            arguments.append(
+                (src_test_dir, test_file, launcher_args, test_file_relpath)
+            )
+        max_workers = int(os.getenv("MAX_WORKERS_FLUENT_TESTS", 4))
+        if max_workers > 1:
+            with concurrent.futures.ThreadPoolExecutor(
+                max_workers=max_workers
+            ) as executor:
+                futures = [
+                    executor.submit(_run_single_test_with_status_print, *args)
+                    for args in arguments
+                ]
+                for future in concurrent.futures.as_completed(futures):
+                    statuses.append(future.result())
+        else:
+            for args in arguments:
+                statuses.append(_run_single_test_with_status_print(*args))
+        if any(statuses):
             exit(1)

.github/workflows/ci.yml

@@ -117,14 +117,16 @@ jobs:
 
       - name: Install Quarto
         uses: quarto-dev/quarto-actions/setup@v2
-        with:
-          tinytex: true
-
+
       - name: Check Quarto Version
         shell: bash
         run: |
           quarto --version
 
+      - name: Verify tinytex is installed
+        run: |
+          quarto install tinytex --no-prompt --update-path
+
       - name: "Install Poppler for PDF to PNG conversion"
         shell: bash
         run: |
@@ -197,6 +199,7 @@ jobs:
           make build-doc-source
         env:
           FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
+          PYFLUENT_DOC_SKIP_CHEATSHEET: 1
 
       - name: Zip HTML Documentation before upload
         run: |

.github/workflows/test-fluent-journals.yml

@@ -83,3 +83,9 @@ jobs:
       - name: Run Fluent tests
         run: |
           make write-and-run-fluent-tests
+        env:
+          MAX_WORKERS_FLUENT_TESTS: 1
+
+      - name: Cleanup previous docker containers
+        if: always()
+        run: make cleanup-previous-docker-containers

CONTRIBUTORS.md

@@ -13,4 +13,4 @@
 * [Harshal Pohekar](https://github.com/hpohekar)
 * [Mainak Kundu](https://github.com/mkundu1)
 * [Prithwish Mukherjee](https://github.com/prmukherj)
-* [Raphael Luciano](https://github.com/raph-luc)
+* [Raphael Luciano](https://github.com/raph-luc)

doc/api_rstgen.py

@@ -173,8 +173,8 @@ def _generate_api_source_rst_files(folder: str, files: list):
                             f".. automodule:: ansys.fluent.core.{folder}.{file}\n"
                         )
                 else:
-                    rst.write(f"ansys.fluent.core.{file}\n")
-                    rst.write(f'{"="*(len(f"ansys.fluent.core.{file}"))}\n\n')
+                    rst.write(f"{file}\n")
+                    rst.write(f'{"="*(len(f"{file}"))}\n\n')
                     rst.write(f".. automodule:: ansys.fluent.core.{file}\n")
                 if "root" not in file:
                     _write_common_rst_members(rst_file=rst)
@@ -191,8 +191,8 @@ def _generate_api_index_rst_files():
             file = _get_file_path(folder, "index")
             with open(file, "w", encoding="utf8") as index:
                 index.write(f".. _ref_{folder}:\n\n")
-                index.write(f"ansys.fluent.core.{folder}\n")
-                index.write(f'{"="*(len(f"ansys.fluent.core.{folder}"))}\n\n')
+                index.write(f"{folder}\n")
+                index.write(f'{"="*(len(f"{folder}"))}\n\n')
                 index.write(f".. automodule:: ansys.fluent.core.{folder}\n")
                 _write_common_rst_members(rst_file=index)
                 index.write(".. toctree::\n")

doc/source/api/index.rst

@@ -10,6 +10,7 @@ full guidelines on their use.
 .. toctree::
     :maxdepth: 2
     :hidden:
+    :caption: ansys.fluent.core
 
     filereader/index
     launcher/index