PyCFX documentation |version|
=============================

.. toctree::
   :hidden:
   :maxdepth: 2

   getting_started/getting_started_contents
   user_guide/user_guide_contents
   examples/index
   api/api_contents
   contributing/contributing_contents
   changelog

Welcome to PyCFX
-----------------
PyCFX provides a modern Python interface to unlock the full potential of Ansys CFX. It empowers
engineers and developers to automate, customize, and streamline CFD workflows.

Why use PyCFX?
--------------
- **Automate**: Eliminate repetitive tasks and accelerate simulation workflows.
- **Customize**: Control CFX behavior with Python for tailored solutions.
- **Improve efficiency**: Reduce manual steps and improve reproducibility.
- **Integrate**: Seamlessly work with other Python libraries and tools.

How it works
------------
PyCFX connects to Ansys CFX and enables programmatic interaction using a
modern Python API. It supports simulation setup, execution, and results
extraction.

Compatibility
-------------
PyCFX supports Ansys CFX 2025 R2 Service Pack 3 and later.

Resources
---------

- `PyCFX GitHub repository <https://github.com/ansys/pycfx>`_
- `CFX documentation <https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/prod_page.html?pn=CFX>`_
- `Ansys customer portal <https://support.ansys.com>`_

Need help?
----------

- `Submit a bug report <https://github.com/ansys/pycfx/issues>`_.
- `Contact support <https://support.ansys.com>`_.

For information on reporting issues or contributing via GitHub, see :ref:`ref_contributing`.