ansys-fluent-core 0.31.dev1__py3-none-any.whl → 0.31.1__py3-none-any.whl

ansys/fluent/core/launcher/container_launcher.py

@@ -38,6 +38,7 @@ Examples
 import inspect
 import logging
 import os
+import time
 from typing import Any
 
 from ansys.fluent.core.fluent_connection import FluentConnection
@@ -45,6 +46,7 @@ from ansys.fluent.core.launcher.fluent_container import (
     configure_container_dict,
     start_fluent_container,
 )
+from ansys.fluent.core.launcher.launcher_utils import is_compose
 from ansys.fluent.core.launcher.process_launch_string import (
     _build_fluent_launch_args_string,
 )
@@ -58,6 +60,7 @@ from ansys.fluent.core.launcher.pyfluent_enums import (
     _get_argvals_and_session,
 )
 import ansys.fluent.core.launcher.watchdog as watchdog
+from ansys.fluent.core.session import _parse_server_info_file
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 _THIS_DIR = os.path.dirname(__file__)
@@ -65,6 +68,21 @@ _OPTIONS_FILE = os.path.join(_THIS_DIR, "fluent_launcher_options.json")
 logger = logging.getLogger("pyfluent.launcher")
 
 
+def _get_server_info_from_container(config_dict):
+    """Retrieve the server info from a specified file in a container."""
+
+    host_server_info_file = config_dict["host_server_info_file"]
+
+    time_limit = 0
+    while not host_server_info_file.exists():
+        time.sleep(2)
+        time_limit += 2
+        if time_limit > 60:
+            raise FileNotFoundError(f"{host_server_info_file} not found.")
+
+    return _parse_server_info_file(str(host_server_info_file))
+
+
 class DockerLauncher:
     """Instantiates Fluent session in container mode."""
 
@@ -198,9 +216,16 @@ class DockerLauncher:
                 del config_dict_h
             return config_dict
 
-        port, password, container = start_fluent_container(
-            self._args, self.argvals["container_dict"]
-        )
+        if is_compose():
+            port, config_dict, container = start_fluent_container(
+                self._args, self.argvals["container_dict"]
+            )
+
+            _, _, password = _get_server_info_from_container(config_dict=config_dict)
+        else:
+            port, password, container = start_fluent_container(
+                self._args, self.argvals["container_dict"]
+            )
 
         fluent_connection = FluentConnection(
             port=port,
@@ -209,6 +234,7 @@ class DockerLauncher:
             cleanup_on_exit=self.argvals["cleanup_on_exit"],
             slurm_job_id=self.argvals and self.argvals.get("slurm_job_id"),
             inside_container=True,
+            container=container,
         )
 
         session = self.new_session(
@@ -217,12 +243,17 @@ class DockerLauncher:
             file_transfer_service=self.file_transfer_service,
             start_transcript=self.argvals["start_transcript"],
         )
+
         session._container = container
 
-        if self.argvals["start_watchdog"] is None and self.argvals["cleanup_on_exit"]:
-            self.argvals["start_watchdog"] = True
-        if self.argvals["start_watchdog"]:
-            logger.debug("Launching Watchdog for Fluent container...")
-            watchdog.launch(os.getpid(), port, password)
+        if not is_compose():
+            if (
+                self.argvals["start_watchdog"] is None
+                and self.argvals["cleanup_on_exit"]
+            ):
+                self.argvals["start_watchdog"] = True
+            if self.argvals["start_watchdog"]:
+                logger.debug("Launching Watchdog for Fluent container...")
+                watchdog.launch(os.getpid(), port, password)
 
         return session

ansys/fluent/core/launcher/fluent_container.py

@@ -78,8 +78,10 @@ import tempfile
 from typing import Any, List
 
 import ansys.fluent.core as pyfluent
+from ansys.fluent.core.docker.docker_compose import ComposeBasedLauncher
+from ansys.fluent.core.launcher.launcher_utils import is_compose
 from ansys.fluent.core.session import _parse_server_info_file
-from ansys.fluent.core.utils.deprecate import deprecate_argument
+from ansys.fluent.core.utils.deprecate import all_deprecators
 from ansys.fluent.core.utils.execution import timeout_loop
 from ansys.fluent.core.utils.networking import get_free_port
 
@@ -116,8 +118,24 @@ class LicenseServerNotSpecified(KeyError):
         )
 
 
-@deprecate_argument("container_mount_path", "mount_target")
-@deprecate_argument("host_mount_path", "mount_source")
+@all_deprecators(
+    deprecate_arg_mappings=[
+        {
+            "old_arg": "container_mount_path",
+            "new_arg": "mount_target",
+            "converter": lambda old_arg_val: old_arg_val,
+        },
+        {
+            "old_arg": "host_mount_path",
+            "new_arg": "mount_source",
+            "converter": lambda old_arg_val: old_arg_val,
+        },
+    ],
+    data_type_converter=None,
+    deprecated_version="v0.23.dev1",
+    deprecated_reason="'container_mount_path' and 'host_mount_path' are deprecated. Use 'mount_target' and 'mount_source' instead.",
+    warn_message="",
+)
 def configure_container_dict(
     args: List[str],
     mount_source: str | Path | None = None,
@@ -288,6 +306,7 @@ def configure_container_dict(
             environment={
                 "ANSYSLMD_LICENSE_FILE": license_server,
                 "REMOTING_PORTS": f"{container_grpc_port}/portspan=2",
+                "FLUENT_ALLOW_REMOTE_GRPC_CONNECTION": "1",
             }
         )
 
@@ -381,6 +400,11 @@ def configure_container_dict(
 
     host_server_info_file = Path(mount_source) / container_server_info_file.name
 
+    if is_compose():
+        container_dict["host_server_info_file"] = host_server_info_file
+        container_dict["mount_source"] = mount_source
+        container_dict["mount_target"] = mount_target
+
     return (
         container_dict,
         timeout,
@@ -451,34 +475,49 @@ def start_fluent_container(
         del container_vars_tmp
 
     try:
-        if not host_server_info_file.exists():
-            host_server_info_file.parents[0].mkdir(exist_ok=True)
+        if is_compose():
+            config_dict["fluent_port"] = port
 
-        host_server_info_file.touch(exist_ok=True)
-        last_mtime = host_server_info_file.stat().st_mtime
+            compose_container = ComposeBasedLauncher(container_dict=config_dict)
 
-        import docker
+            if not compose_container.check_image_exists():
+                logger.debug(
+                    f"Fluent image {config_dict['fluent_image']} not found. Pulling image..."
+                )
+                compose_container.pull_image()
 
-        docker_client = docker.from_env()
+            compose_container.start()
 
-        logger.debug("Starting Fluent docker container...")
+            return port, config_dict, compose_container
+        else:
+            if not host_server_info_file.exists():
+                host_server_info_file.parents[0].mkdir(exist_ok=True)
 
-        container = docker_client.containers.run(
-            config_dict.pop("fluent_image"), **config_dict
-        )
+            host_server_info_file.touch(exist_ok=True)
+            last_mtime = host_server_info_file.stat().st_mtime
 
-        success = timeout_loop(
-            lambda: host_server_info_file.stat().st_mtime > last_mtime, timeout
-        )
+            import docker
+
+            docker_client = docker.from_env()
 
-        if not success:
-            raise TimeoutError(
-                "Fluent container launch has timed out, stop container manually."
+            logger.debug("Starting Fluent docker container...")
+
+            container = docker_client.containers.run(
+                config_dict.pop("fluent_image"), **config_dict
             )
-        else:
-            _, _, password = _parse_server_info_file(str(host_server_info_file))
 
-            return port, password, container
+            success = timeout_loop(
+                lambda: host_server_info_file.stat().st_mtime > last_mtime, timeout
+            )
+
+            if not success:
+                raise TimeoutError(
+                    "Fluent container launch has timed out, stop container manually."
+                )
+            else:
+                _, _, password = _parse_server_info_file(str(host_server_info_file))
+
+                return port, password, container
     finally:
         if remove_server_info_file and host_server_info_file.exists():
             host_server_info_file.unlink()

ansys/fluent/core/launcher/launcher.py

@@ -54,12 +54,11 @@ from ansys.fluent.core.launcher.server_info import _get_server_info
 from ansys.fluent.core.launcher.slurm_launcher import SlurmFuture, SlurmLauncher
 from ansys.fluent.core.launcher.standalone_launcher import StandaloneLauncher
 import ansys.fluent.core.launcher.watchdog as watchdog
-from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
 from ansys.fluent.core.session_meshing import Meshing
 from ansys.fluent.core.session_pure_meshing import PureMeshing
 from ansys.fluent.core.session_solver import Solver
 from ansys.fluent.core.session_solver_icing import SolverIcing
-from ansys.fluent.core.utils.deprecate import deprecate_argument
+from ansys.fluent.core.utils.deprecate import all_deprecators
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 _THIS_DIR = os.path.dirname(__file__)
@@ -127,17 +126,23 @@ def _version_to_dimension(old_arg_val):
 
 
 #   pylint: disable=unused-argument
-@deprecate_argument(
-    old_arg="show_gui",
-    new_arg="ui_mode",
-    converter=_show_gui_to_ui_mode,
-    warning_cls=PyFluentDeprecationWarning,
-)
-@deprecate_argument(
-    old_arg="version",
-    new_arg="dimension",
-    converter=_version_to_dimension,
-    warning_cls=PyFluentDeprecationWarning,
+@all_deprecators(
+    deprecate_arg_mappings=[
+        {
+            "old_arg": "show_gui",
+            "new_arg": "ui_mode",
+            "converter": _show_gui_to_ui_mode,
+        },
+        {
+            "old_arg": "version",
+            "new_arg": "dimension",
+            "converter": _version_to_dimension,
+        },
+    ],
+    data_type_converter=None,
+    deprecated_version="v0.22.dev0",
+    deprecated_reason="'show_gui' and 'version' are deprecated. Use 'ui_mode' and 'dimension' instead.",
+    warn_message="",
 )
 def launch_fluent(
     product_version: FluentVersion | str | float | int | None = None,
@@ -179,6 +184,12 @@ def launch_fluent(
         Version of Ansys Fluent to launch. To use Fluent version 2025 R1, pass
         any of  ``FluentVersion.v251``, ``"25.1.0"``, ``"25.1"``, ``25.1``or ``251``.
         The default is ``None``, in which case the newest installed version is used.
+        PyFluent uses the ``AWP_ROOT<ver>`` environment variable to locate the Fluent
+        installation, where ``<ver>`` is the Ansys release number such as ``251``.
+        The ``AWP_ROOT<ver>`` environment variable is automatically configured on Windows
+        system when Fluent is installed. On Linux systems, ``AWP_ROOT<ver>`` must be
+        configured to point to the absolute path of an Ansys installation such as
+        ``/apps/ansys_inc/v251``.
     dimension : Dimension or int, optional
         Geometric dimensionality of the Fluent simulation. The default is ``None``,
         in which case ``Dimension.THREE`` is used. Options are either the values of the

ansys/fluent/core/launcher/launcher_utils.py

@@ -37,6 +37,14 @@ from ansys.fluent.core.utils.networking import find_remoting_ip
 logger = logging.getLogger("pyfluent.launcher")
 
 
+def is_compose() -> bool:
+    """Check if the Fluent launch is through compose."""
+    return (
+        os.getenv("PYFLUENT_USE_DOCKER_COMPOSE") == "1"
+        or os.getenv("PYFLUENT_USE_PODMAN_COMPOSE") == "1"
+    )
+
+
 def is_windows():
     """Check if the current operating system is Windows."""
     return platform.system() == "Windows"

ansys/fluent/core/launcher/process_launch_string.py

@@ -150,10 +150,6 @@ def get_fluent_exe_path(**launch_argvals) -> Path:
         Fluent executable path
     """
 
-    def get_fluent_root(version: FluentVersion) -> Path:
-        awp_root = os.environ[version.awp_var]
-        return Path(awp_root) / "fluent"
-
     def get_exe_path(fluent_root: Path) -> Path:
         if launcher_utils.is_windows():
             return fluent_root / "ntbin" / "win64" / "fluent.exe"
@@ -171,7 +167,7 @@ def get_fluent_exe_path(**launch_argvals) -> Path:
     # 2. product_version parameter passed with launch_fluent
     product_version = launch_argvals.get("product_version")
     if product_version:
-        return get_exe_path(get_fluent_root(FluentVersion(product_version)))
+        return FluentVersion(product_version).get_fluent_exe_path()
 
     # (DEV) "PYFLUENT_FLUENT_ROOT" environment variable
     fluent_root = os.getenv("PYFLUENT_FLUENT_ROOT")
@@ -179,4 +175,4 @@ def get_fluent_exe_path(**launch_argvals) -> Path:
         return get_exe_path(Path(fluent_root))
 
     # 3. the latest ANSYS version from AWP_ROOT environment variables
-    return get_exe_path(get_fluent_root(FluentVersion.get_latest_installed()))
+    return FluentVersion.get_latest_installed().get_fluent_exe_path()

ansys/fluent/core/launcher/slurm_launcher.py

@@ -459,6 +459,7 @@ class SlurmLauncher:
         launch_cmd += _build_journal_argument(
             self._argvals["topy"], self._argvals["journal_file_names"]
         )
+        launch_cmd += ' -setenv="FLUENT_ALLOW_REMOTE_GRPC_CONNECTION=1"'
 
         logger.debug(f"Launching Fluent with command: {launch_cmd}")
         proc = subprocess.Popen(launch_cmd, **kwargs)

ansys/fluent/core/report.py

@@ -56,6 +56,8 @@ ANSYS_ENV_VARS = [
     "REMOTING_PORTS",
     "REMOTING_SERVER_ADDRESS",
     "SERVER_INFO_DIR",
+    "PYFLUENT_USE_DOCKER_COMPOSE",
+    "PYFLUENT_USE_PODMAN_COMPOSE",
 ]
 
 

ansys/fluent/core/services/deprecated_field_data.py

@@ -42,7 +42,7 @@ from ansys.fluent.core.services.field_data import (
     get_fields_request,
     override_help_text,
 )
-from ansys.fluent.core.utils.deprecate import deprecate_argument
+from ansys.fluent.core.utils.deprecate import all_deprecators
 
 DEPRECATION_MSG = "'field_data_old' is deprecated. Use 'field_data' instead."
 
@@ -297,15 +297,23 @@ class DeprecatedFieldData:
             self._allowed_vector_field_names,
         )
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_scalar_field_data(
         self,
@@ -336,7 +344,6 @@ class DeprecatedFieldData:
             IDs are provided as input, a dictionary containing a map of surface IDs to scalar
             field data.
         """
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,
@@ -376,20 +383,28 @@ class DeprecatedFieldData:
                 for surface_id in surface_ids
             }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
-    )
-    @deprecate_argument(
-        old_arg="data_type",
-        new_arg="data_types",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+            {
+                "old_arg": "data_type",
+                "new_arg": "data_types",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_names', 'surface_ids' and 'data_type' are deprecated. Use 'surfaces' and 'data_types' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_surface_data(
         self,
@@ -421,7 +436,6 @@ class DeprecatedFieldData:
              If surface IDs are provided as input, a dictionary containing a map of surface IDs to face
              vertices, connectivity data, and normal or centroid data is returned.
         """
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,
@@ -509,15 +523,23 @@ class DeprecatedFieldData:
                     for surface_id in surface_ids
                 }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_vector_field_data(
         self,
@@ -540,7 +562,6 @@ class DeprecatedFieldData:
             If surface IDs are provided as input, a dictionary containing a map of
             surface IDs to vector field data is returned.
         """
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,
@@ -579,15 +600,23 @@ class DeprecatedFieldData:
                 for surface_id in surface_ids
             }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_pathlines_field_data(
         self,
@@ -648,7 +677,6 @@ class DeprecatedFieldData:
         """
         if zones is None:
             zones = []
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,