Metadata-Version: 2.4
Name: ansys-cfx-core
Version: 0.2.1
Summary: PyCFX is a Python wrapper for Ansys CFX, the gold standard CFD software for turbomachinery applications.
Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Requires-Python: >=3.10,<3.15
Description-Content-Type: text/x-rst
License-Expression: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
License-File: LICENSE
Requires-Dist: importlib-metadata>=8.0.0
Requires-Dist: ansys-api-cfx>=0.3.0
Requires-Dist: ansys-platform-instancemanagement>=1.0.0
Requires-Dist: ansys-tools-filetransfer>=0.1,<0.3
Requires-Dist: ansys-units>=0.10.0
Requires-Dist: beartype>=0.17,<0.23
Requires-Dist: docker>=7.1.0
Requires-Dist: grpcio>=1.30.0
Requires-Dist: grpcio-health-checking>=1.30.0
Requires-Dist: h5py==3.16.0
Requires-Dist: lxml>=6.0.0
Requires-Dist: nltk>=3.8.1
Requires-Dist: numpy>=2.2.3
Requires-Dist: pandas>=2.0.3
Requires-Dist: platformdirs>=4.2.2
Requires-Dist: psutil>=7.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests==2.33.1
Requires-Dist: typing-extensions>=4.12.0
Requires-Dist: ansys-sphinx-theme[changelog]>=1.2.7 ; extra == "doc"
Requires-Dist: Sphinx>=8.1.3 ; extra == "doc"
Requires-Dist: numpydoc>=1.7.0 ; extra == "doc"
Requires-Dist: sphinx-copybutton>=0.5.1 ; extra == "doc"
Requires-Dist: sphinxcontrib-openapi==0.9.0 ; extra == "doc"
Requires-Dist: tzdata>=2025.1 ; extra == "doc"
Requires-Dist: pytz>=2025.1 ; extra == "doc"
Requires-Dist: sphinx-design>=0.6.1 ; extra == "doc"
Requires-Dist: sphinx-gallery>=0.15.0 ; extra == "doc"
Requires-Dist: sphinx-jinja>=2.0.2 ; extra == "doc"
Requires-Dist: autodocsumm>=0.2.14 ; extra == "doc"
Requires-Dist: black>=24.1.1 ; extra == "style"
Requires-Dist: isort>=5.13.2 ; extra == "style"
Requires-Dist: codespell>=2.2.6 ; extra == "style"
Requires-Dist: pytest==9.0.2 ; extra == "tests"
Requires-Dist: pytest-cov==7.1.0 ; extra == "tests"
Requires-Dist: pytest-mock==3.15.1 ; extra == "tests"
Requires-Dist: pytest-xdist==3.8.0 ; extra == "tests"
Project-URL: Documentation, https://cfx.docs.pyansys.com
Project-URL: Homepage, https://github.com/ansys/pycfx
Project-URL: Source, https://github.com/ansys/pycfx
Project-URL: Tracker, https://github.com/ansys/pycfx/issues
Provides-Extra: doc
Provides-Extra: style
Provides-Extra: tests

PyCFX
=====
|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-cfx-core?logo=pypi
   :target: https://pypi.org/project/ansys-cfx-core/
   :alt: Python

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-cfx-core.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/ansys-cfx-core
   :alt: PyPI

.. |GH-CI| image:: https://github.com/ansys/pycfx/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/ansys/pycfx/actions/workflows/ci_cd.yml
   :alt: GH-CI

.. |codecov| image:: https://codecov.io/gh/ansys/pycfx/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/ansys/pycfx
   :alt: Codecov

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/license/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/pycfx/main.svg
   :target: https://results.pre-commit.ci/latest/github/ansys/pycfx/main
   :alt: pre-commit.ci status

Overview
--------
PyCFX is a Python wrapper for Ansys CFX, the industry-leading CFD software for turbomachinery
applications. You can use it to perform these tasks:

- Launch CFX from a local Ansys installation.
- Create, modify, and run CFX simulations in a Python environment.
- Postprocess simulation results.

Documentation and issues
------------------------
Documentation for the latest stable release of PyCFX is hosted at
`PyCFX documentation`_.

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.

On the `PyCFX Issues`_ page, you can create issues to report bugs and request new features.

For general PyAnsys support, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.

Installation
------------
PyCFX supports Python 3.10 through 3.14 on Windows and Linux.

You can install it from `PyPI`_ with this command:

.. code:: console

   pip install ansys-cfx-core

For developers
^^^^^^^^^^^^^^
If you plan on doing local *development* of PyCFX with Git, install
the latest release with these commands:

.. code:: console

   git clone https://github.com/ansys/pycfx

   python -m pip install -U pip tox

   cd pycfx
   pip install -e .[doc,tests,style]
   python codegen/allapigen.py  # Generates the API files

Dependencies
------------
You must have a licensed copy of Ansys CFX installed locally. PyCFX supports CFX 2025 R2 Service Pack 3 and later.

On Windows, the Ansys CFX installer automatically sets the required environment variables. For example, using CFX 2025 R2 installed in the default directory, the installer sets the ``AWP_ROOT252`` environment variable to ``C:\Program Files\ANSYS Inc\v252``.

On Linux, you must set the required environment variable manually. For example, using CFX 2025 R2 in the default directory, run this command:

.. code:: console

    export AWP_ROOT252=/usr/ansys_inc/v252

To make this setting persistent for the current user, add this same export command to the ``~/.profile`` file or equivalent.

Getting started
---------------

Launch CFX
^^^^^^^^^^
To launch CFX from Python using a local installation, run these commands:

.. code:: python

  import ansys.cfx.core as pycfx
  pypre = pycfx.PreProcessing.from_install()   # Start CFX-Pre
  pysolve = pycfx.Solver.from_install()        # Start a Solver session
  pypost = pycfx.PostProcessing.from_install() # Start CFD-Post

Find examples in the `examples/` folder of the repository.


License and acknowledgments
---------------------------
PyCFX is licensed under the MIT license.

PyCFX makes no commercial claim over Ansys whatsoever. This library
extends the functionality of Ansys CFX by adding a Python interface
to CFX without changing the core behavior or license of the original
software. The use of PyCFX to run the CFX software requires a
legally licensed copy of CFX.

For more information on CFX, see the `Ansys CFX`_ page on the Ansys website.

.. LINKS AND REFERENCES
.. _Ansys CFX: https://www.ansys.com/products/fluids/ansys-cfx
.. _PyCFX documentation: https://cfx.docs.pyansys.com/
.. _PyCFX Issues: https://github.com/ansys/pycfx/issues
.. _PyPI: https://pypi.org/project/ansys-cfx-core/

