ansys-fluent-core 0.20.dev9__tar.gz → 0.20.dev10__tar.gz

ansys_fluent_core-0.20.dev10/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.1
+Name: ansys-fluent-core
+Version: 0.20.dev10
+Summary: PyFluent provides Pythonic access to Ansys Fluent
+Home-page: https://github.com/ansys/pyfluent
+License: MIT
+Author: ANSYS, Inc.
+Author-email: ansys.support@ansys.com
+Maintainer: PyAnsys developers
+Maintainer-email: pyansys.maintainers@ansys.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: reader
+Provides-Extra: tests
+Requires-Dist: ansys-api-fluent (>=0.3.22,<0.4.0)
+Requires-Dist: ansys-platform-instancemanagement (>=1.0,<2.0)
+Requires-Dist: ansys-units (>=0.3.2,<0.4.0)
+Requires-Dist: beartype (>=0.17,<0.18)
+Requires-Dist: docker (>=6.1.3,<7.0.0)
+Requires-Dist: grpcio (>=1.30.0,<2.0.0)
+Requires-Dist: grpcio-health-checking (>=1.30.0,<2.0.0)
+Requires-Dist: h5py (==3.10.0) ; extra == "reader"
+Requires-Dist: importlib-metadata (>=7.0.1,<8.0.0) ; python_version < "3.9"
+Requires-Dist: lxml (>=4.9.2,<5.0.0)
+Requires-Dist: numpy (>=1.21.5,<2.0.0)
+Requires-Dist: pandas (>=1.1.5,<2.0.0)
+Requires-Dist: platformdirs (>=3.5.1,<4.0.0)
+Requires-Dist: psutil (>=5.9.5,<6.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Project-URL: Documentation, https://fluent.docs.pyansys.com/
+Project-URL: Repository, https://github.com/ansys/pyfluent
+Project-URL: Source, https://github.com/ansys/pyfluent
+Project-URL: Tracker, https://github.com/ansys/pyfluent/issues
+Description-Content-Type: text/x-rst
+
+PyFluent
+========
+|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| |pre-commit|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-fluent-core?logo=pypi
+   :target: https://pypi.org/project/ansys-fluent-core/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-fluent-core.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-fluent-core
+   :alt: PyPI
+
+.. |GH-CI| image:: https://github.com/ansys/pyfluent/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/ansys/pyfluent/actions/workflows/ci.yml
+   :alt: GH-CI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/pyfluent/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/pyfluent
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+   :target: https://github.com/psf/black
+   :alt: Black
+
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyfluent/main.svg
+   :target: https://results.pre-commit.ci/latest/github/ansys/pyfluent/main
+   :alt: pre-commit.ci status
+
+Overview
+--------
+PyFluent provides Pythonic access to Ansys Fluent. Its features enable the seamless use of
+Fluent within the Python ecosystem and broad access to native Fluent features, including the
+ability to:
+
+- Launch Fluent using a local Ansys installation
+- Use Fluent's TUI (text user interface) commands for both meshing and solver features
+- Use Fluent's built-in postprocessing capabilities
+
+Documentation and issues
+------------------------
+Documentation for the latest stable release of PyFluent is hosted at
+`PyFluent documentation <https://fluent.docs.pyansys.com/version/stable/>`_.
+
+In the upper right corner of the documentation's title bar, there is an option for switching from
+viewing the documentation for the latest stable release to viewing the documentation for the
+development version or previously released versions.
+
+You can also `view <https://cheatsheets.docs.pyansys.com/pyfluent_cheat_sheet.png>`_ or
+`download <https://cheatsheets.docs.pyansys.com/pyfluent_cheat_sheet.pdf>`_ the
+PyFluent cheat sheet. This one-page reference provides syntax rules and commands
+for using PyFluent. 
+
+On the `PyFluent Issues <https://github.com/ansys/pyfluent/issues>`_ page, you can create
+issues to report bugs and request new features. On the `PyFluent Discussions
+<https://github.com/ansys/pyfluent/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_
+page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback. 
+
+To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
+
+Installation
+------------
+The ``ansys-fluent-core`` package supports Python 3.9 through Python
+3.11 on Windows and Linux.
+
+Install the latest release from `PyPI
+<https://pypi.org/project/ansys-fluent-core/>`_ with:
+
+.. code:: console
+
+   pip install ansys-fluent-core
+
+For developers
+--------------
+If you plan on doing local *development* of PyFluent with Git, install
+the latest release with:
+
+.. code:: console
+
+   git clone https://github.com/ansys/pyfluent.git
+   cd pyfluent
+   pip install pip -U
+   pip install -e .
+   python codegen/allapigen.py  # Generates the API files
+
+Dependencies
+------------
+You must have a licensed copy of Ansys Fluent installed locally. PyFluent
+supports Fluent 2022 R2 and later. The Windows installation of Ansys Fluent automatically
+sets the required environment variables so that PyFluent can find the Ansys Fluent
+installation. Using Fluent 2023 R2 (or 23.2) installed in the default directory as an
+example, the installer automatically sets the ``AWP_ROOT232`` environment variable to point
+to ``C:\Program Files\ANSYS Inc\v232``.
+
+On Linux, the required environment variable is not set automatically, and can be set for the
+current user in the current shell session, using Fluent 2023 R1 in the default installation
+directory as an example, before running PyFluent, with:
+
+.. code:: console
+
+    export AWP_ROOT232=/usr/ansys_inc/v232
+
+For this setting to persist between different shell sessions for the current user, the same
+export command can instead be added to the user's ``~/.profile`` file.
+
+Getting started
+---------------
+
+Launching Fluent
+~~~~~~~~~~~~~~~~
+To launch Fluent from Python, use the ``launch_fluent`` method:
+
+.. code:: python
+
+  import ansys.fluent.core as pyfluent
+  solver_session = pyfluent.launch_fluent(mode="solver")
+  solver_session.health_check_service.is_serving
+
+Basic usage
+~~~~~~~~~~~
+You can use the ``solver_session.tui`` interface to run all Fluent TUI commands:
+
+.. code:: python
+
+  solver_session.tui.file.read_case('elbow.cas.h5')
+  solver_session.tui.define.models.unsteady_2nd_order("yes")
+  solver_session.tui.solve.initialize.initialize_flow()
+  solver_session.tui.solve.dual_time_iterate(2, 3)
+
+You can also install and use these PyFluent libraries:
+
+- `PyFluent Parametric <https://parametric.fluent.docs.pyansys.com/>`_, which provides
+  access to Fluent's parametric workflows.
+- `PyFluent Visualization <https://visualization.fluent.docs.pyansys.com/>`_, which
+  provides postprocessing and visualization capabilities using the `pyvista <https://docs.pyvista.org/>`_
+  and `matplotlib <https://matplotlib.org/>`_ packages.
+
+License and acknowledgments
+---------------------------
+PyFluent is licensed under the MIT license.
+
+PyFluent makes no commercial claim over Ansys whatsoever. This library
+extends the functionality of Ansys Fluent by adding a Python interface
+to Fluent without changing the core behavior or license of the original
+software. The use of the interactive Fluent control of PyFluent requires a
+legally licensed local copy of Fluent.
+
+For more information on Fluent, see the `Ansys Fluent <https://www.ansys.com/products/fluids/ansys-fluent>`_
+page on the Ansys website.
+

ansys_fluent_core-0.20.dev10/pyproject.toml

@@ -0,0 +1,189 @@
+[build-system]
+requires = ["poetry-core>=1.9.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+# Check https://python-poetry.org/docs/pyproject/ for all available sections
+name = "ansys-fluent-core"
+version = "0.20.dev10"
+description = "PyFluent provides Pythonic access to Ansys Fluent"
+license = "MIT"
+authors = ["ANSYS, Inc. <ansys.support@ansys.com>"]
+maintainers = ["PyAnsys developers <pyansys.maintainers@ansys.com>"]
+readme = "README.rst"
+repository = "https://github.com/ansys/pyfluent"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+include = [
+    { path = "src/ansys/fluent/core/fluent_version_*.py", format = ["sdist", "wheel"] },
+    { path = "src/ansys/fluent/core/meshing/tui_*.py", format = ["sdist", "wheel"] },
+    { path = "src/ansys/fluent/core/solver/tui_*.py", format = ["sdist", "wheel"] },
+    { path = "src/ansys/fluent/core/datamodel_*/*.py", format = ["sdist", "wheel"] },
+    { path = "src/ansys/fluent/core/solver/settings_*/*.py", format = ["sdist", "wheel"] },
+]
+
+packages = [
+    { include = "ansys", from = "src" },
+    { include = "tests", to = "ansys/fluent" },
+    { include = "README.rst", to = "ansys/fluent/core/docs" },
+]
+
+[tool.poetry.dependencies]
+python = ">=3.9,<4.0"
+importlib-metadata = {version = "^7.0.1", python = "<3.9"}
+ansys-api-fluent = "^0.3.22"
+ansys-platform-instancemanagement = "^1.0"
+ansys-units = "^0.3.2"
+beartype = "^0.17"
+docker = "^6.1.3"
+grpcio = "^1.30.0"
+grpcio-health-checking = "^1.30.0"
+h5py = { version = "==3.10.0", optional = true }
+lxml = "^4.9.2"
+numpy= "^1.21.5"
+pandas = "^1.1.5"
+platformdirs = "^3.5.1"
+psutil = "^5.9.5"
+pyyaml = "^6.0"
+requests = "^2.31.0"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+Sphinx = "==7.2.6"
+jupyter_sphinx = "==0.5.3"
+numpydoc = "==1.6.0"
+matplotlib = "==3.8.2"
+ansys-sphinx-theme = "==0.13.2"
+pypandoc = "==1.12"
+pytest-sphinx = "==0.5.0"
+sphinx-autobuild = "==2021.3.14"
+sphinx-autodoc-typehints = "==1.25.3"
+sphinx-copybutton = "==0.5.2"
+sphinx-gallery = "==0.15.0"
+sphinx-notfound-page = "==1.0.0"
+sphinxcontrib-websupport = "==1.2.7"
+sphinxemoji = "==0.3.1"
+sphinx-toggleprompt = "==0.5.2"
+autodocsumm = "==0.2.12"
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.test.dependencies]
+pytest = "==8.0.2"
+pytest-cov = "==4.1.0"
+pytest-mock = "==3.12.0"
+
+[tool.poetry.extras]
+reader = ["h5py"]
+tests = ["pytest", "pytest-cov", "pytest-mock"]
+
+[tool.poetry.urls]
+"Documentation" = "https://fluent.docs.pyansys.com/"
+"Source" = "https://github.com/ansys/pyfluent"
+"Tracker" = "https://github.com/ansys/pyfluent/issues"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = """
+-v
+--durations=0
+--show-capture=all
+"""
+markers = [
+    "settings_only: Read and modify the case settings only, without loading the mesh, initializing, or solving the case",
+    "nightly: Tests that run under nightly CI",
+    "codegen_required: Tests that requires codegen",
+    "fluent_version(version): Tests that runs with specified Fluent version",
+    "standalone: Tests that cannot be run within container"
+]
+
+
+[tool.black]
+extend-exclude = "/(src/ansys/fluent/core/meshing/tui*|src/ansys/fluent/core/solver/tui*|src/ansys/fluent/core/solver/settings*|src/ansys/fluent/core/datamodel*)/"
+
+
+[tool.isort]
+profile = "black"
+force_sort_within_sections = true
+line_length = 88
+default_section = "THIRDPARTY"
+skip_glob = [
+    "src/ansys/fluent/core/meshing/tui",
+    "src/ansys/fluent/core/solver/tui",
+    "src/ansys/fluent/core/datamodel_222",
+    "src/ansys/fluent/core/datamodel_231",
+    "src/ansys/fluent/core/datamodel_232",
+    "src/ansys/fluent/core/datamodel_241",
+    "src/ansys/fluent/core/solver/settings_222",
+    "src/ansys/fluent/core/solver/settings_231",
+    "src/ansys/fluent/core/solver/settings_232",
+    "src/ansys/fluent/core/solver/settings_241"
+]
+filter_files = "true"
+known_first_party = ["ansys"]
+
+
+[tool.codespell]
+skip = "*.xml,./src/ansys/fluent/core/meshing/tui*,./src/ansys/fluent/core/solver/tui*,./src/ansys/fluent/core/datamodel_222/*,./src/ansys/fluent/core/datamodel_231/*,./src/ansys/fluent/core/datamodel_232/*,./src/ansys/fluent/core/datamodel_241/*,./codegen/data/fluent_gui_help.xml,./src/ansys/fluent/core/solver/settings_222/*,./src/ansys/fluent/core/solver/settings_231/*,./src/ansys/fluent/core/solver/settings_232/*,./src/ansys/fluent/core/solver/settings_241/*"
+ignore-words = ".github/styles/config/vocabularies/ANSYS/accept.txt"
+
+
+[tool.docformatter]
+in-place = "true"
+exclude = [
+    "tests/",
+    "src/ansys/fluent/core/meshing/tui_222.py",
+    "src/ansys/fluent/core/solver/tui_222.py",
+    "src/ansys/fluent/core/solver/settings_222/",
+    "src/ansys/fluent/core/datamodel_222/",
+    "src/ansys/fluent/core/meshing/tui_231.py",
+    "src/ansys/fluent/core/solver/tui_231.py",
+    "src/ansys/fluent/core/solver/settings_231/",
+    "src/ansys/fluent/core/datamodel_231/",
+    "src/ansys/fluent/core/meshing/tui_232.py",
+    "src/ansys/fluent/core/solver/tui_232.py",
+    "src/ansys/fluent/core/solver/settings_232/",
+    "src/ansys/fluent/core/datamodel_232/",
+    "src/ansys/fluent/core/meshing/tui_241.py",
+    "src/ansys/fluent/core/solver/tui_241.py",
+    "src/ansys/fluent/core/solver/settings_241/",
+    "src/ansys/fluent/core/datamodel_241/"
+]
+black = "true"
+non-cap = [
+    "initDatamodel",
+    "getAttributeValue",
+    "getState",
+    "setState",
+    "updateDict",
+    "deleteObject",
+    "executeCommand",
+    "createCommandArguments",
+    "deleteCommandArguments",
+    "getSpecs",
+    "getStaticInfo",
+    "subscribeEvents",
+    "unsubscribeEvents"
+]
+
+
+[tool.coverage.run]
+source = ["ansys/fluent"]
+omit = [
+    "*/ansys/fluent/core/fluent_version_*",
+    "*/ansys/fluent/core/meshing/tui_*",
+    "*/ansys/fluent/core/solver/tui_*",
+    "*/ansys/fluent/core/solver/settings_*/*",
+    "*/ansys/fluent/core/datamodel_*/*"
+]
+
+[tool.coverage.report]
+show_missing = true

ansys_fluent_core-0.20.dev10/src/ansys/fluent/core/__init__.py

@@ -0,0 +1,90 @@
+"""A package providing Fluent's Solver and Meshing capabilities in Python."""
+
+import os
+import pydoc
+
+import platformdirs
+
+# Logging has to be set up before importing other PyFluent modules
+import ansys.fluent.core.logging as logging
+
+logging.root_config()
+logging.configure_env_var()
+
+from ansys.fluent.core._version import __version__  # noqa: F401
+from ansys.fluent.core.get_build_details import (  # noqa: F401
+    get_build_version,
+    get_build_version_string,
+)
+from ansys.fluent.core.launcher.launcher import (  # noqa: F401
+    connect_to_fluent,
+    launch_fluent,
+)
+from ansys.fluent.core.launcher.pyfluent_enums import (  # noqa: F401
+    FluentLinuxGraphicsDriver,
+    FluentMode,
+    FluentWindowsGraphicsDriver,
+    UIMode,
+)
+from ansys.fluent.core.services.batch_ops import BatchOps  # noqa: F401
+from ansys.fluent.core.session import BaseSession as Fluent  # noqa: F401
+from ansys.fluent.core.utils import fldoc
+from ansys.fluent.core.utils.fluent_version import FluentVersion  # noqa: F401
+from ansys.fluent.core.utils.search import search  # noqa: F401
+from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
+from ansys.fluent.core.warnings import PyFluentDeprecationWarning  # noqa: F401
+
+_VERSION_INFO = "Build date: March 20, 2024 16:02 UTC ShaID: dc3ec3e"
+"""Global variable indicating the version of the PyFluent package - Empty by default"""
+
+_THIS_DIRNAME = os.path.dirname(__file__)
+_README_FILE = os.path.normpath(os.path.join(_THIS_DIRNAME, "docs", "README.rst"))
+
+if os.path.exists(_README_FILE):
+    with open(_README_FILE, encoding="utf8") as f:
+        __doc__ = f.read()
+
+
+def version_info() -> str:
+    """Method returning the version of PyFluent being used.
+
+    Returns
+    -------
+    str
+        The PyFluent version being used.
+
+    Notes
+    -------
+    Only available in packaged versions. Otherwise it will return __version__.
+    """
+    return _VERSION_INFO if _VERSION_INFO is not None else __version__
+
+
+# Setup data directory
+USER_DATA_PATH = platformdirs.user_data_dir(
+    appname="ansys_fluent_core", appauthor="Ansys"
+)
+EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
+
+# Set this to False to stop automatically inferring and setting REMOTING_SERVER_ADDRESS
+INFER_REMOTING_IP = True
+
+# Time in second to wait for response for each ip while inferring remoting ip
+INFER_REMOTING_IP_TIMEOUT_PER_IP = 2
+
+pydoc.text.docother = fldoc.docother.__get__(pydoc.text, pydoc.TextDoc)
+
+# Whether to use datamodel state caching
+DATAMODEL_USE_STATE_CACHE = True
+
+# Whether to use datamodel attribute caching
+DATAMODEL_USE_ATTR_CACHE = True
+
+# Whether stream and cache commands state
+DATAMODEL_USE_NOCOMMANDS_DIFF_STATE = True
+
+
+def wrap_api_call(f, *args, **kwargs):
+    """Wrap API call."""
+    # overwritten in PyConsole
+    return f(*args, **kwargs)

ansys_fluent_core-0.20.dev10/src/ansys/fluent/core/_version.py

@@ -0,0 +1,15 @@
+"""Version of ansys-fluent-core module.
+
+On the ``main`` branch, use 'dev0' to denote a development version.
+For example:
+version_info = 0, 1, 'dev0'
+"""
+
+# major, minor, patch
+version_info = 0, 20, "dev10"
+
+# Nice string for the version
+__version__ = ".".join(map(str, version_info))
+
+# Current Fluent version
+fluent_release_version = "24.1.0"