From 081d6af607a6be2973c3f06bd1162441095910eb Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Tue, 5 Jul 2022 15:19:04 -0400 Subject: [PATCH] Tidy up main doc landing page. --- doc/source/index.rst | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 5ae2ecbd9489..c62e98f0872e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -34,12 +34,11 @@ What is PyFluent? ----------------- PyFluent is part of the `PyAnsys `_ ecosystem that -lets you use Ansys Fluent within or alongside any other Python environment, -whether it is in conjunction with other Ansys Python libraries and packages or -with other external Python products. +lets you use Ansys Fluent within any other Python environment in conjunction +with other PyAnsys libraries and with other external Python libraries. PyFluent implements a client-server architecture. PyFluent launches or connects -with a running Fluent process as a server using Google remote procedure calls, +with a running Fluent process as a server using Google remote procedure calls, or gRPC interfaces, but all you need to interact with is the Python interface. You can use PyFluent to programmatically create, interact with and control an @@ -49,13 +48,24 @@ customized scripts. Features -------- -The primary package, ``ansys-fluent``, provides features such as: +The primary package, ``ansys-fluent-core``, provides features such as: +- Ability to launch the Fluent solver in serial or parallel and connect to + already running Fluent sessions using the :ref:`ref_launcher_launcher` module. - Scripting of Fluent's meshing capabilities. See the :ref:`ref_meshing` module for more information. -- Scripting using Fluent's TUI commands. See the :ref:`ref_solver_tui` module for - more information about the available commands. -- and more... +- Scripting using all of Fluent's TUI commands. See the :ref:`ref_solver_tui` + module for more information about the available commands. +- Ability to run more than one Fluent session asynchronously. See the + :ref:`ref_utils` module for more information. +- Ability to retrive Fluent field data as numpy arryas for custom post + processing using standard Python libraries such as matplotlib. See the + :ref:`ref_field_data` module for more information. +- Ability to register function callbacks on Fluent solver events such as when a + case or data file is read, or the Fluent solver completes an iteration. See + the :ref:`ref_events` module for more information. +- Ability to retrive solver monitors such as residuals using the + :ref:`ref_monitors` module. Documentation and Issues ------------------------ @@ -63,9 +73,9 @@ Documentation and Issues In addition to installation, usage, and contribution information, the PyFluent documentation provides API documentation, examples, and code guidelines. -On the PyFluent Issues page, you can create issues to submit questions, -report bugs, and request new features. To reach the project support team, -email pyansys.support@ansys.com. +On the PyFluent Issues page, you can create issues to submit questions, report +bugs, and request new features. To reach the project support team, email +pyansys.support@ansys.com. License -------