PyFluent documentation |version|
================================

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

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


Welcome to PyFluent
-------------------
PyFluent is your gateway to harnessing the power of Ansys Fluent through
Python. It enables engineers and developers to automate, customize, and
streamline CFD workflows using the flexibility of Python.


Why Use PyFluent?
-----------------

- **Automation**: Eliminate repetitive tasks and accelerate simulation workflows.
- **Customization**: Control Fluent behavior with Python for tailored solutions.
- **Efficiency**: Reduce manual steps and improve reproducibility.
- **Integration**: Seamlessly integrate with other Python libraries and tools.


How It Works
------------

PyFluent connects to Ansys Fluent and allows programmatic interaction using a
modern Python API. It supports simulation setup, execution, monitoring, and results
extraction.


Compatibility
-------------
PyFluent supports **Ansys Fluent 2022 R2 and later**.

**Note:** PyFluent is *not supported* when using a **Fluent Pro** license.


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

Get started with PyFluent by following the steps in the :ref:`getting_started` guide.


Resources
---------

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


Need Help?
----------

Visit the community or support resources:

- `Ansys developer forum <https://discuss.ansys.com>`_
- `Submit a bug report <https://github.com/ansys/pyfluent/issues>`_
- `Contact support <https://support.ansys.com>`_

See :ref:`ref_contributing` for how to report issues or contribute via GitHub.
