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.

Sign up for GitHub

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

Jump to bottom

Improving Linux usage documentation #1614

Merged
merged 1 commit into from
May 18, 2023
Merged

Improving Linux usage documentation #1614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 16 additions & 14 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,22 @@ the latest release with:
Dependencies
------------
You must have a licensed copy of Ansys Fluent installed locally. PyFluent
supports Fluent 2022 R2 and later.
supports Fluent 2022 R2 and later. The Windows installation of Ansys Fluent automatically
sets the required environment variables so that PyFluent can find the Ansys Fluent
installation. Using Fluent 2023 R1 (or 23.1) installed in the default directory as an
example, the installer automatically sets the ``AWP_ROOT231`` environment variable to point
to ``C:\Program Files\ANSYS Inc\v231``.

On Linux, the required environment variable is not set automatically, and can be set for the
current user in the current shell session, using Fluent 2023 R1 in the default installation
directory as an example, before running PyFluent, with:

.. code:: console

export AWP_ROOT231=/usr/ansys_inc/v231

For this setting to persist between different shell sessions for the current user, the same
export command can instead be added to the user's ``~/.profile`` file.

Getting started
---------------
Expand All @@ -89,19 +104,6 @@ To launch Fluent from Python, use the ``launch_fluent`` method:
solver_session = pyfluent.launch_fluent(mode="solver")
solver_session.health_check_service.is_serving

On Windows systems the environment variable ``AWP_ROOT<ver>`` is configured
when Fluent is installed, where ``<ver>`` is the Fluent release number such as
``231`` for release 2023 R1. PyFluent automatically uses this environment
variable to locate the latest Fluent installation. On Linux systems configure
``AWP_ROOT<ver>`` to point to the absolute path of an Ansys installation such as
``/apps/ansys_inc/v231``.

To use a specific Fluent release, set ``AWP_ROOT<ver>`` where ``<ver>`` is the
Fluent release that you would like to use. For example, ``AWP_ROOT<231>`` uses release 2023 R1.

For information on other ways of specifying the Fluent location for PyFluent,
see `Frequently asked questions <https://fluent.docs.pyansys.com/release/0.12/getting_started/faqs.html>`_.

Basic usage
~~~~~~~~~~~
You can use the ``solver_session.tui`` interface to run all Fluent TUI commands:
Expand Down