ansys-fluent-core 0.28.2__tar.gz → 0.29.0__tar.gz

ansys_fluent_core-0.29.0/.ci/compare_flobject.py

@@ -0,0 +1,40 @@
+"""Provides a module to compare flobject.py."""
+
+import platform
+import subprocess
+import uuid
+
+
+def compare_flobject():
+    """Compare flobject.py.
+
+    Raises
+    ------
+    RuntimeError
+        If flobject.py is inconsistent in Fluent and PyFluent.
+    """
+    image_name = "ghcr.io/ansys/pyfluent:v24.1.0"
+    container_name = uuid.uuid4().hex
+    is_linux = platform.system() == "Linux"
+    subprocess.run(
+        f"docker container create --name {container_name} {image_name}",
+        shell=is_linux,
+    )
+    xml_source = "/ansys_inc/v241/fluent/fluent24.1.0/cortex/pylib/flapi/flobject.py"
+    subprocess.run(
+        f"docker cp {container_name}:{xml_source} fluent_flobject.py", shell=is_linux
+    )
+    subprocess.run(f"docker container rm {container_name}", shell=is_linux)
+    p = subprocess.run(
+        "diff -u fluent_flobject.py src/ansys/fluent/core/solver/flobject.py",
+        shell=is_linux,
+        capture_output=True,
+        text=True,
+    )
+    print(p.stdout)
+    if p.returncode != 0:
+        raise RuntimeError("flobject.py is different in Fluent and PyFLuent.")
+
+
+if __name__ == "__main__":
+    compare_flobject()

ansys_fluent_core-0.29.0/.ci/fluent_test_runner.py

@@ -0,0 +1,168 @@
+"""Script to run Fluent test in Docker container."""
+
+import argparse
+import concurrent.futures
+import logging
+import os
+from pathlib import Path
+from shutil import copytree
+from tempfile import TemporaryDirectory
+from time import sleep
+
+import yaml
+
+import ansys.fluent.core as pyfluent
+from ansys.fluent.core import FluentVersion
+import docker
+
+
+class FluentRuntimeError(RuntimeError):
+    """Exception raised when stderr is detected in Fluent output."""
+
+    pass
+
+
+def _run_single_test(
+    src_test_dir: Path, journal_file: Path, launcher_args: str
+) -> None:
+    """Run a single Fluent test.
+
+    Parameters
+    ----------
+    src_test_dir : Path
+        Path to the Fluent test directory in the host.
+
+    journal_file : Path
+        Absolute path to the journal file.
+
+    launcher_args : str, optional
+        Additional arguments for the Fluent launcher.
+
+    Raises
+    ------
+    FluentRuntimeError
+        Raised when stderr is detected in Fluent output.
+    """
+    logging.debug(f"journal_file: {journal_file}")
+    src_pyfluent_dir = str(Path(pyfluent.__file__).parent)
+    verion_for_file_name = FluentVersion.current_dev().number
+    dst_pyfluent_dir = f"/ansys_inc/v{verion_for_file_name}/commonfiles/CPython/3_10/linx64/Release/python/lib/python3.10/site-packages/ansys/fluent/core"
+    src_gen_dir = (
+        Path(pyfluent.__file__).parent / "ansys" / "fluent" / "core" / "generated"
+    )
+    dst_gen_dir = f"/ansys_inc/v{verion_for_file_name}/fluent/fluent{FluentVersion.current_dev()!r}/cortex/pylib/flapi/generated"
+    dst_test_dir = "/testing"
+    working_dir = Path(dst_test_dir)
+    parent = journal_file.parent
+    parents = []
+    while parent != src_test_dir:
+        parents.append(parent.name)
+        parent = parent.parent
+    parents.reverse()
+    for parent in parents:
+        working_dir /= parent
+    working_dir = str(working_dir)
+    src_test_dir = str(src_test_dir)
+    logging.debug(f"src_pyfluent_dir: {src_pyfluent_dir}")
+    logging.debug(f"dst_pyfluent_dir: {dst_pyfluent_dir}")
+    logging.debug(f"src_test_dir: {src_test_dir}")
+    logging.debug(f"dst_test_dir: {dst_test_dir}")
+    logging.debug(f"working_dir: {working_dir}")
+
+    docker_client = docker.from_env()
+    version_for_image_tag = FluentVersion.current_dev().docker_image_tag
+    image_name = f"ghcr.io/ansys/pyfluent:{version_for_image_tag}"
+    container = docker_client.containers.run(
+        image=image_name,
+        volumes=[
+            f"{src_pyfluent_dir}:{dst_pyfluent_dir}",
+            f"{src_gen_dir}:{dst_gen_dir}",  # Try removing this after pyfluent is updated in commonfiles
+            f"{src_test_dir}:{dst_test_dir}",
+        ],
+        working_dir=working_dir,
+        environment={"ANSYSLMD_LICENSE_FILE": os.environ["ANSYSLMD_LICENSE_FILE"]},
+        command=f"{launcher_args} -gu -py -i {journal_file.name}",
+        detach=True,
+        stdout=True,
+        stderr=True,
+        auto_remove=True,
+    )
+    try:
+        while True:
+            container.reload()
+            if container.status == "exited":
+                break
+            stderr = container.logs(stdout=False, stderr=True)
+            if stderr:
+                stderr = stderr.decode()
+                for line in stderr.splitlines():
+                    if line.strip().startswith("Error:"):
+                        if "Expected exception" in line:  # for check_assert.py
+                            container.stop()
+                        else:
+                            raise FluentRuntimeError(stderr)
+            sleep(1)
+        print(container.logs(stderr=True).decode())
+        container.remove()
+    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(
+        "test_dir",
+        help="Path to the Fluent test directory relative to the PyFluent repository root.",
+    )
+    args = parser.parse_args()
+    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)
+        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")
+            launcher_args = ""
+            if config_file.exists():
+                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))
+            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)

ansys_fluent_core-0.29.0/.ci/pull_fluent_image.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# Image name
+SHA='sha256'
+SUBSTRING=$(echo ${FLUENT_IMAGE_TAG}| cut -c 1-6)
+if [ "$SUBSTRING" == "$SHA" ]
+then
+  _IMAGE_NAME="ghcr.io/ansys/pyfluent@${FLUENT_IMAGE_TAG}"
+else
+  _IMAGE_NAME="ghcr.io/ansys/pyfluent:${FLUENT_IMAGE_TAG:-latest}"
+fi
+
+# Pull fluent image based on tag
+docker pull $_IMAGE_NAME
+
+# Remove all dangling images
+docker image prune -f

ansys_fluent_core-0.29.0/.flake8

@@ -0,0 +1,7 @@
+[flake8]
+exclude = src/ansys/fluent/core/generated
+count = True
+statistics = True
+max-complexity = 10
+max-line-length = 88
+extend-ignore = E203, E501, C901

ansys_fluent_core-0.29.0/.gitattributes

@@ -0,0 +1,6 @@
+* text=auto !eol
+*.sh         eol=lf
+*.bat        eol=crlf
+*.py         text
+*.json       text
+*.zip filter=lfs diff=lfs merge=lfs -text

ansys_fluent_core-0.29.0/.github/dependabot.yml

@@ -0,0 +1,28 @@
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    insecure-external-code-execution: allow
+    schedule:
+      interval: "monthly"
+    labels:
+      - "Maintenance"
+      - "Dependencies"
+    groups:
+      dependencies:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels:
+      - "Maintenance"
+    groups:
+      actions:
+        patterns:
+          - "*"

ansys_fluent_core-0.29.0/.github/labeler.yml

@@ -0,0 +1,19 @@
+documentation:
+- changed-files:
+  - any-glob-to-any-file: ['doc/source/**/*', 'examples/**/*', 'doc/styles/**/*']
+
+examples:
+- changed-files:
+  - any-glob-to-any-file: ['examples/**/*']
+
+maintenance:
+- changed-files:
+  - any-glob-to-any-file: ['.github/**/*', 'codecov.yml', '.flake8', '.coveragerc', 'pyproject.toml', 'doc/make.bat', 'doc/Makefile']
+
+dependencies:
+- changed-files:
+  - any-glob-to-any-file: ['pyproject.toml']
+
+CI/CD:
+- changed-files:
+  - any-glob-to-any-file: ['docker/**/*', '.github/**/*', '.ci/**/*']

ansys_fluent_core-0.29.0/.github/labels.yml

@@ -0,0 +1,152 @@
+#############################################################
+# Reason for this file
+# ====================
+#
+# This file is used by labeler to sync the labels (and their colors),
+# and assign a label to the new pull request.
+# 
+# Check the yml for more info: .github\workflows\label.yml
+#
+
+#############################################################
+# NOTES
+# =====
+#
+# If the labels names are change, the file ``./.github/release.yml`` should be also updated!
+#
+
+#############################################################
+# Main colors (hex)
+# =================
+
+# C0392B # Red: International Orange (Golden Gate Bridge)
+# E67E22 # Orange: Vivid Tangelo
+# F4D03F # Yellow: Sandstorm
+# F9E79F # Light yellow: Medium champagne
+# 27AE60 # Green: Green (Crayola)
+# ffffff # White
+# 2E86C1 # Dark blue: Cyan Cornflower Blue
+# 85C1E9 # Light blue: Aero
+# A569BD # Purple: Rich Lavender
+# 76D7C4 # Light green: Pearl Aqua
+# 000000 # Black
+
+# https://htmlcolorcodes.com/ -- For color picking
+# https://www.color-name.com/ -- For colors to names
+
+#############################################################
+# By priority
+# ===========
+
+- name: BLOCKER
+  description: "No further development until this is fixed"
+  color: C0392B
+
+- name: critical priority
+  description: "This issue affects almost all users"
+  color: E67E22
+
+- name: major priority
+  description: "This issue affects some users"
+  color: F4D03F
+
+- name: minor priority
+  description: "This issue affects few users"
+  color: F9E79F
+
+- name: future
+  description: "To work on it in the future, since it can be delayed"
+  color: 27AE60
+
+- name: won't fix
+  description: "For different reasons, this won't be fixed"
+  color: ffffff
+
+#############################################################
+# By Category
+# ===========
+
+- name: bug
+  description: "Issue, problem or error in PyMAPDL"
+  color: E67E22
+
+- name: new feature
+  description: "Request or proposal for a new feature"
+  color: 85C1E9
+  
+- name: enhancement
+  description: "Improve any current implemented feature"
+  color: 85C1E9
+
+- name: examples
+  description: "Publishing PyMAPDL examples"
+  color: A569BD
+
+- name: documentation
+  description: "Documentation related (improving, adding, etc)"
+  color: A569BD
+
+- name: maintenance
+  description: "General maintenance of the repo (libraries, cicd, etc)"
+  color: 76D7C4
+
+- name: discussion
+  description: ""
+  color: 76D7C4
+
+- name: question
+  description: ""
+  color: 76D7C4
+
+#############################################################
+# Issue management
+# ================
+
+- name: duplicate
+  description: "Duplicated issue"
+  color: E67E22
+
+- name: good first issue
+  description: "Best way to start working on PyMAPDL development"
+  color: 27AE60
+
+- name: help wanted!
+  description: "Tell the developers you need help or guidance"
+  color: F4D03F
+
+- name: stale
+  description: "Stale issue likely to be closed soon"
+  color: E67E22
+
+- name: waiting doc review
+  description: "This PR is waiting for its documentation to be reviewed."
+  color: 27AE60
+
+#############################################################
+# For repo maintenance
+# ====================
+# (Only maintainers should use them)
+
+- name: DO NOT MERGE
+  description: "Not ready to be merged yet"
+  color: C0392B
+
+- name: CI/CD
+  description: "Related with CICD, Github Actions, etc"
+  color: F9E79F
+
+- name: dependencies
+  description: ""
+  color: F9E79F
+
+- name: MAPDL
+  description: "Requires changes in MAPDL"
+  color: 000000
+
+- name: reminder
+  description: "Related to the reminder bot"
+  color: ffffff
+
+- name: build failed
+  description: "Schedule build fails"
+  color: E67E22

ansys_fluent_core-0.29.0/.github/styles/.gitignore

@@ -0,0 +1,4 @@
+*
+!Vocab
+!Vocab/**
+!.gitignore

ansys_fluent_core-0.29.0/.github/styles/config/vocabularies/ANSYS/accept.txt

@@ -0,0 +1,80 @@
+(?i)Ansys
+(?i)gRPC
+(?i)PyAnsys
+[Ff]luent
+[Jj]ournaling
+[Mm]atplotlib
+[Pp]athlines
+[Pp]ostprocessing
+[Ss]ession
+[Ss]ettings
+[Ss]treaming
+API
+batch_ops
+CAD
+caf
+CaseFile
+CommandArguments
+DataFile
+Dockerfile
+endblock
+endfor
+endif
+error_handler
+events
+EventsManager
+falsy
+field_data
+Fluent's
+fluent_connection
+fullname
+health_check
+hexahedral
+inout
+interceptors
+load_machines
+machine_list
+mass_average
+mass_flow
+mass_integrated_average
+mesher
+meshing's
+meshing_queries
+meshing_workflow
+metaclass
+metaclasses
+monitor
+MonitorsManager
+numpy
+postprocess
+PIM
+PyFluent
+Pythonic
+post_helper
+post_objects_container
+pyvista
+rpc
+rpvars
+sbatch
+scheme_eval
+session_base_meshing
+session_meshing
+session_pure_meshing
+session_solver
+session_solver_icing
+session_solver_lite
+slurm
+Slurm
+SVAR
+svar_data
+svar_info
+SVARs
+solution_variable_data
+solution_variable_info
+transcript
+TUI
+UDFs
+Univa
+venv
+create_workflow
+load_workflow