Skip to content

Tidy up documentation for setting the installation paths. #902

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

Merged
dnwillia-work merged 2 commits into from
Sep 26, 2022
Merged

Tidy up documentation for setting the installation paths. #902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a26d834
Tidy up documentation for setting the installation paths.
dnwillia-work Sep 16, 2022
1c5db4b
Merge branch 'main' into fix/docpaths
seanpearsonuk Sep 23, 2022
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
15 changes: 11 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ``<version>/fluent`` directory, where ``<version>``
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<ver>``, is configured
when Fluent is installed, where ``<ver>`` 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<ver>`` 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<ver>`` or set the
``PYFLUENT_FLUENT_ROOT`` environment variable to the ``<install
location>/<version>/fluent`` directory, where ``<version>`` is the Fluent
release that you would like to use. For example, ``v222`` uses release 2022 R2.

Basic Usage
~~~~~~~~~~~
Expand Down
15 changes: 13 additions & 2 deletions doc/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<ver>``, is configured
when Fluent is installed, where ``<ver>`` 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<ver>`` 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<ver>`` or set the
``PYFLUENT_FLUENT_ROOT`` environment variable to the ``<install
location>/<version>/fluent`` directory, where ``<version>`` 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

Expand Down