Skip to content

Commit b716d65

Browse files
docs: make homepage more appealing (#4223)
The PyFluent documentation home page is fragmented into too many small sections, some of which are thin in content and repetitive. This pull request address that. --------- Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent ea4bb3c commit b716d65

File tree

2 files changed

+28
-29
lines changed

2 files changed

+28
-29
lines changed

doc/changelog.d/4223.documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
make homepage more appealing

doc/source/index.rst

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,58 +13,56 @@ PyFluent documentation |version|
1313
changelog
1414

1515

16-
Welcome to PyFluent documentation
17-
---------------------------------
18-
Welcome to the official documentation for PyFluent, your gateway to harnessing
19-
the power of Ansys Fluent through Python.
16+
Welcome to PyFluent
17+
-------------------
18+
PyFluent is your gateway to harnessing the power of Ansys Fluent through
19+
Python. It enables engineers and developers to automate, customize, and
20+
streamline CFD workflows using the flexibility of Python.
2021

2122

22-
Overview of PyFluent
23-
--------------------
24-
PyFluent is a Python library that enables users to interact with Ansys Fluent,
25-
a powerful computational fluid dynamics (CFD) tool, programmatically. PyFluent
26-
allows you to automate, customize, and streamline your CFD workflows using the
27-
flexibility and power of Python.
23+
Why Use PyFluent?
24+
-----------------
2825

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

30-
Integration with Fluent
31-
-----------------------
3231

33-
While Ansys Fluent provides a comprehensive graphical interface for CFD simulations,
34-
PyFluent extends its capabilities by offering a programmatic approach. This integration
35-
allows for enhanced automation, scripting, and the development of custom applications.
32+
How It Works
33+
------------
3634

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

38-
Key features
39-
------------
4039

41-
- **Automation**: Automate repetitive tasks and complex workflows.
42-
- **Customization**: Tailor Fluent operations to specific needs with Python scripts.
43-
- **Efficiency**: Improve productivity by reducing manual intervention.
44-
- **Flexibility**: Seamlessly integrate with other Python libraries and tools.
40+
Compatibility
41+
-------------
42+
PyFluent supports **Ansys Fluent 2022 R2 and later**.
4543

4644

4745
Getting started
4846
---------------
4947

50-
To get started with PyFluent, follow the steps on the :ref:`getting_started` page.
48+
Get started with PyFluent by following the steps in the :ref:`getting_started` guide.
5149

52-
Useful links
53-
------------
50+
51+
Resources
52+
---------
5453

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

5958

60-
Community and support
61-
---------------------
59+
Need Help?
60+
----------
6261

63-
Join the community to get help and share your experiences with other users:
62+
Visit the community or support resources:
6463

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

69-
See :ref:`ref_contributing` for guidance on how you can contribute to PyFluent
70-
by reporting issues, suggesting features, or submitting pull requests on GitHub.
68+
See :ref:`ref_contributing` for how to report issues or contribute via GitHub.

0 commit comments

Comments
 (0)