ansys-fluent-core 0.14.dev1__tar.gz → 0.14.dev2__tar.gz

ansys-fluent-core-0.14.dev2/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.1
+Name: ansys-fluent-core
+Version: 0.14.dev2
+Summary: Pythonic interface to Ansys Fluent
+Home-page: https://github.com/ansys/pyfluent
+Author: ANSYS, Inc.
+Author-email: pyansys.core@ansys.com
+Maintainer: PyAnsys developers
+Maintainer-email: pyansys.maintainers@ansys.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+
+PyFluent
+========
+|pyansys| |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
+
+.. |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
+------------------------
+For comprehensive information on PyFluent, see the latest release
+`documentation <https://fluent.docs.pyansys.com>`_.
+
+On the `PyFluent Issues <https://github.com/ansys/pyfluent/issues>`_ page, you can create
+issues to submit questions, report bugs, and request new features. To reach
+the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
+
+Installation
+------------
+The ``ansys-fluent-core`` package supports Python 3.8 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
+
+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 R1 (or 23.1) installed in the default directory as an
+example, the installer automatically sets the ``AWP_ROOT231`` environment variable to point
+to ``C:\Program Files\ANSYS Inc\v231``.
+
+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_ROOT231=/usr/ansys_inc/v231
+
+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.14.dev2/README.rst

@@ -0,0 +1,137 @@
+PyFluent
+========
+|pyansys| |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
+
+.. |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
+------------------------
+For comprehensive information on PyFluent, see the latest release
+`documentation <https://fluent.docs.pyansys.com>`_.
+
+On the `PyFluent Issues <https://github.com/ansys/pyfluent/issues>`_ page, you can create
+issues to submit questions, report bugs, and request new features. To reach
+the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
+
+Installation
+------------
+The ``ansys-fluent-core`` package supports Python 3.8 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
+
+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 R1 (or 23.1) installed in the default directory as an
+example, the installer automatically sets the ``AWP_ROOT231`` environment variable to point
+to ``C:\Program Files\ANSYS Inc\v231``.
+
+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_ROOT231=/usr/ansys_inc/v231
+
+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.14.dev2/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+    "setuptools>=45.0",
+    "wheel>=0.37.0",
+]
+
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--ignore-glob=tests/test_pro/* --ignore-glob=tests/test_datamodel_server/*"
+markers = [
+    "integration: Short-running tests which read a simple input file and check the exposure and values of various setting objects",
+    "quick: Run the quick tests",
+    "setup: Read different input files, setup the simulation, initialize, and run for a few iterations and check the results",
+    "solve: Long-running tests that continue until convergence",
+    "mesh: Tests covering meshing scenarios",
+    "optislang: Test Optislang integration scenarios",
+    "dev: Tests that must be successful before PR merge, includes unmarked tests",
+    "nightly: Tests that run under nightly CI",
+    "fluent_222: Tests that run with Fluent 22.2",
+    "fluent_231: Tests that run with Fluent 23.1",
+    "fluent_232: Tests that run with Fluent 23.2",
+    "fluent_241: Tests that run with Fluent 24.1",
+]
+
+
+[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/solver/settings_222",
+    "src/ansys/fluent/core/solver/settings_231",
+]
+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/*,./codegen/data/fluent_gui_help.xml,./src/ansys/fluent/core/solver/settings_222/*,./src/ansys/fluent/core/solver/settings_231/*"
+ignore-words = "doc/styles/Vocab/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/"
+]
+pre-summary-space = true
+wrap-descriptions = 88
+wrap-summaries = 88
+
+
+[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.14.dev2/setup.py

@@ -0,0 +1,65 @@
+"""Setup file for ansys-fluent-core."""
+import os
+import shutil
+
+from setuptools import find_namespace_packages, setup
+
+# Get version from version info
+__version__ = None
+_THIS_FILE = os.path.dirname(__file__)
+_VERSION_FILE = os.path.join(
+    _THIS_FILE, "src", "ansys", "fluent", "core", "_version.py"
+)
+with open(_VERSION_FILE, mode="r", encoding="utf8") as fd:
+    # execute file from raw string
+    exec(fd.read())
+
+# Copy README.rst file to docs folder in ansys.fluent.core
+_README_FILE = os.path.join(_THIS_FILE, "README.rst")
+_DOCS_FILE = os.path.join(
+    _THIS_FILE, "src", "ansys", "fluent", "core", "docs", "README.rst"
+)
+shutil.copy2(_README_FILE, _DOCS_FILE)
+
+install_requires = [
+    "ansys-api-fluent==0.3.12",
+    "ansys-platform-instancemanagement~=1.0",
+    "grpcio>=1.30.0",
+    "numpy>=1.21.5",
+    "appdirs>=1.4.0",
+    "pandas>=1.1.5",
+    "h5py>=3.8.0",
+    "lxml>=4.9.2",
+    "pyyaml",
+]
+
+
+packages = []
+for package in find_namespace_packages(where="src", include="ansys*"):
+    if package.startswith("ansys.fluent"):
+        packages.append(package)
+
+setup(
+    name="ansys-fluent-core",
+    packages=packages,
+    package_dir={"": "src"},
+    include_package_data=True,
+    version=__version__,
+    description="Pythonic interface to Ansys Fluent",
+    long_description=open(_README_FILE, encoding="utf8").read(),
+    long_description_content_type="text/x-rst",
+    license="MIT",
+    author="ANSYS, Inc.",
+    author_email="pyansys.core@ansys.com",
+    maintainer="PyAnsys developers",
+    maintainer_email="pyansys.maintainers@ansys.com",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    url="https://github.com/ansys/pyfluent",
+    python_requires=">=3.8",
+    install_requires=install_requires,
+)

ansys-fluent-core-0.14.dev2/src/ansys/fluent/core/__init__.py

@@ -0,0 +1,79 @@
+"""A package providing Fluent's Solver and Meshing capabilities in Python."""
+
+import logging.config
+import os
+import pydoc
+
+import appdirs
+import yaml
+
+from ansys.fluent.core._version import __version__  # noqa: F401
+from ansys.fluent.core.launcher.launcher import (  # noqa: F401
+    FluentVersion,
+    LaunchMode,
+    launch_fluent,
+)
+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.setup_for_fluent import setup_for_fluent  # noqa: F401
+
+_VERSION_INFO = "Build date: May 19, 2023 17:23 UTC ShaID: 162e819"
+"""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__
+
+
+file_path = os.path.abspath(__file__)
+file_dir = os.path.dirname(file_path)
+yaml_path = os.path.join(file_dir, "logging_config.yaml")
+
+# Load the logging configuration from a YAML file
+with open(yaml_path, "rt") as f:
+    config = yaml.safe_load(f)
+
+# Configure the logging system
+logging.config.dictConfig(config)
+
+# Setup data directory
+USER_DATA_PATH = appdirs.user_data_dir(appname="ansys_fluent_core", appauthor="Ansys")
+EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
+
+BUILDING_GALLERY = False
+
+# 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

ansys-fluent-core-0.14.dev2/src/ansys/fluent/core/_version.py

@@ -0,0 +1,12 @@
+"""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, 14, "dev2"
+
+# Nice string for the version
+__version__ = ".".join(map(str, version_info))

ansys-fluent-core-0.14.dev2/src/ansys/fluent/core/docs/README.rst

@@ -0,0 +1,137 @@
+PyFluent
+========
+|pyansys| |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
+
+.. |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
+------------------------
+For comprehensive information on PyFluent, see the latest release
+`documentation <https://fluent.docs.pyansys.com>`_.
+
+On the `PyFluent Issues <https://github.com/ansys/pyfluent/issues>`_ page, you can create
+issues to submit questions, report bugs, and request new features. To reach
+the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
+
+Installation
+------------
+The ``ansys-fluent-core`` package supports Python 3.8 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
+
+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 R1 (or 23.1) installed in the default directory as an
+example, the installer automatically sets the ``AWP_ROOT231`` environment variable to point
+to ``C:\Program Files\ANSYS Inc\v231``.
+
+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_ROOT231=/usr/ansys_inc/v231
+
+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.