Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidy up main doc landing page. #590

Merged
merged 1 commit into from
Jul 6, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ What is PyFluent?
-----------------

PyFluent is part of the `PyAnsys <https://docs.pyansys.com>`_ 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 a Python environment of your choice 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
Expand All @@ -49,23 +49,34 @@ 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 retrieve 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 retrieve solver monitors such as residuals using the
:ref:`ref_monitors` module.

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 [email protected].
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
[email protected].

License
-------
Expand Down