Skip to content

[462, 463] getting started doc added show_gui option and package names #486

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
merged 2 commits into from
Jun 10, 2022
Merged

[462, 463] getting started doc added show_gui option and package names #486

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5890ec3
getting started doc added show_gui option and package names
hpohekar Jun 9, 2022
362ffc4
show_gui=True and launch_fluent changed to ''show_gui=True'' and ''la…
hpohekar Jun 10, 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
17 changes: 7 additions & 10 deletions doc/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This will allow you to install the PyFluent ``ansys-fluent-core`` module
and modify it locally and have the changes reflected in your setup
after restarting the Python kernel.

****************
****************
Launching Fluent
****************

Expand All @@ -64,7 +64,6 @@ You can launch Fluent from Python using the ``launch_fluent`` function:
import ansys.fluent.core as pyfluent
session = pyfluent.launch_fluent(precision="double", processor_count=2)
session.check_health()
session.start_transcript() # Streaming the transcript locally

Fluent is now active and you can send commands to it as a genuine Python class.
For example, if we wanted to read a case file, update a setting and iterate the
Expand All @@ -77,18 +76,16 @@ solver:
session.solver.tui.solve.initialize.initialize_flow()
session.solver.tui.solve.dual_time_iterate(2, 3)

In addition to all TUI commands being available there are the ``parametric`` and
``post`` packages. The ``parametric`` package provides access to Fluent's
design point capability and the ``post`` package provides integrations with both
In addition to all TUI commands being available there are the `ansys-fluent-parametric <https://github.com/pyansys/pyfluent-parametric>`_ and
`ansys-fluent-visualization <https://github.com/pyansys/pyfluent-visualization>`_ packages. The ``ansys-fluent-parametric`` package provides access to Fluent's
design point capability and the ``ansys-fluent-visualization`` package provides integrations with both
``pyvista`` and ``matplotlib``.

If you want to interact with the Fluent graphical user interface, set the
following environment variable:
If you want to interact with the Fluent graphical user interface, pass ``show_gui=True`` to the ``launch_fluent`` function:

.. code::
.. code:: python

set PYFLUENT_SHOW_SERVER_GUI=1 # Windows
export PYFLUENT_SHOW_SERVER_GUI=1 # Linux (bash)
session = pyfluent.launch_fluent(precision="double", processor_count=2, show_gui=True)

If you want to print the debug information for development, set the following
environment variable:
Expand Down