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

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

   getting_started/index
   user_guide/index
   api/index
   examples/index
   contributing/index


Welcome to PyFluent documentation
---------------------------------
Welcome to the official documentation for PyFluent, your gateway to harnessing
the power of Ansys Fluent through Python.


Overview of PyFluent
--------------------
PyFluent is a Python library that enables users to interact with Ansys Fluent,
a powerful computational fluid dynamics (CFD) tool, programmatically. PyFluent
allows you to automate, customize, and streamline your CFD workflows using the
flexibility and power of Python.


Integration with Fluent
-----------------------

While Ansys Fluent provides a comprehensive graphical interface for CFD simulations,
PyFluent extends its capabilities by offering a programmatic approach. This integration
allows for enhanced automation, scripting, and the development of custom applications.


Key features
------------

- **Automation**: Automate repetitive tasks and complex workflows.
- **Customization**: Tailor Fluent operations to specific needs with Python scripts.
- **Efficiency**: Improve productivity by reducing manual intervention.
- **Flexibility**: Seamlessly integrate with other Python libraries and tools.


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

To get started with PyFluent, follow the steps on the :ref:`getting_started` page.

Useful links
------------

- `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>`_


Community and support
---------------------

Join the community to get help and share your experiences with other users:

- `PyAnsys community forum <https://forum.pyansys.com>`_
- `Submit a bug report <https://github.com/ansys/pyfluent/issues>`_
- `Contact support <https://support.ansys.com>`_

See :ref:`ref_contributing` for guidance on how you can contribute to PyFluent
by reporting issues, suggesting features, or submitting pull requests on GitHub.