diff --git a/README.rst b/README.rst index e52e6d52fa2c..157dfae6471c 100644 --- a/README.rst +++ b/README.rst @@ -82,10 +82,17 @@ To launch Fluent from Python, use the ``launch_fluent`` method: solver_session = pyfluent.launch_fluent(mode="solver") solver_session.check_health() -To use a non-default installation location, set the ``PYFLUENT_FLUENT_ROOT`` -environment variable to the ``/fluent`` directory, where ```` -is the Fluent release that you would like to use. For example, ``v222`` -uses release 2022 R2. +On Windows systems the environment variable ``AWP_ROOT``, is configured +when Fluent is installed, where ```` is the Fluent release number such as +``222`` for release 2022 R2. PyFluent automatically uses this environment +variable to locate the Fluent installation. On Linux systems configure +``AWP_ROOT`` to point to the absolute path of an Ansys installation such as +``/apps/ansys_inc/v222``. + +To use a non-default installation location set ``AWP_ROOT`` or set the +``PYFLUENT_FLUENT_ROOT`` environment variable to the ``//fluent`` directory, where ```` is the Fluent +release that you would like to use. For example, ``v222`` uses release 2022 R2. Basic Usage ~~~~~~~~~~~ diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index b2922234ea73..1f251e119bd9 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -48,9 +48,20 @@ To launch Fluent from PyFluent, use the ``launch_fluent`` method: solver_session = pyfluent.launch_fluent(precision="double", processor_count=2, mode="solver") solver_session.check_health() +On Windows systems the environment variable ``AWP_ROOT``, is configured +when Fluent is installed, where ```` is the Fluent release number such as +``222`` for release 2022 R2. PyFluent automatically uses this environment +variable to locate the Fluent installation. On Linux systems configure +``AWP_ROOT`` to point to the absolute path of an Ansys installation such as +``/apps/ansys_inc/v222``. + +To use a non-default installation location set ``AWP_ROOT`` or set the +``PYFLUENT_FLUENT_ROOT`` environment variable to the ``//fluent`` directory, where ```` is the Fluent +release that you would like to use. For example, ``v222`` uses release 2022 R2. Once Fluent is active, you can use the ``solver_session.tui`` interface to send -Fluent TUI commands to Fluent. For example, you can read a -case file, update a setting, and iterate the solver with: +Fluent TUI commands to Fluent. For example, you can read a case file, update a +setting, and iterate the solver with: .. code:: python