Skip to content

docs: Update ui_mode doc [skip tests] #4533

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 5 commits into from
Oct 9, 2025
Merged

docs: Update ui_mode doc [skip tests] #4533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4844afa
docs: Update ui_mode docstring [skip tests]
hpohekar Oct 8, 2025
2a2c3cd
chore: adding changelog file 4533.documentation.md [dependabot-skip]
pyansys-ci-bot Oct 8, 2025
c2603f6
chore: adding changelog file 4533.documentation.md [dependabot-skip]
pyansys-ci-bot Oct 8, 2025
4254161
docs: Update ui_mode doc
hpohekar Oct 8, 2025
49e3d48
Merge branch 'docs/update_ui_mode_docs' of https://github.com/ansys/p…
hpohekar Oct 8, 2025
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
1 change: 1 addition & 0 deletions doc/changelog.d/4533.documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update ui_mode doc [skip tests]
5 changes: 3 additions & 2 deletions src/ansys/fluent/core/launcher/container_launcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,9 @@ def __init__(
----------
mode : FluentMode
Specifies the launch mode of Fluent to target a specific session type.
ui_mode : UIMode
Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
ui_mode : UIMode or str, optional
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
(for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
Expand Down
8 changes: 2 additions & 6 deletions src/ansys/fluent/core/launcher/launcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,12 +240,8 @@ def launch_fluent(
Fluent transcript subsequently via the method calls, ``transcript.start()``
and ``transcript.stop()`` on the session object.
ui_mode : UIMode or str, optional
Fluent user interface mode. Options are either the values of the ``UIMode``
enum or any of ``"no_gui_or_graphics"``, ``"no_gui"``, ``"hidden_gui"``,
``"no_graphics"`` or ``"gui"``. The default is ``UIMode.HIDDEN_GUI`` in
Windows and ``UIMode.NO_GUI`` in Linux. ``"no_gui_or_graphics"`` and
``"no_gui"`` user interface modes are supported in Windows starting from Fluent
version 2024 R1.
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver or str, optional
Graphics driver of Fluent. In Windows, options are either the values of the
``FluentWindowsGraphicsDriver`` enum or any of ``"null"``, ``"msw"``,
Expand Down
5 changes: 3 additions & 2 deletions src/ansys/fluent/core/launcher/pim_launcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,9 @@ def __init__(
----------
mode : FluentMode
Specifies the launch mode of Fluent for targeting a specific session type.
ui_mode : UIMode
Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
ui_mode : UIMode or str, optional
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
(for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
Expand Down
5 changes: 3 additions & 2 deletions src/ansys/fluent/core/launcher/slurm_launcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,9 @@ def __init__(
----------
mode : FluentMode
Launch mode of Fluent to point to a specific session type.
ui_mode : UIMode
Fluent user interface mode. Options are the values of the ``UIMode`` enum.
ui_mode : UIMode or str, optional
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
Graphics driver of Fluent. Options are the values of the
``FluentWindowsGraphicsDriver`` enum in Windows or the values of the
Expand Down
5 changes: 3 additions & 2 deletions src/ansys/fluent/core/launcher/standalone_launcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,9 @@ def __init__(
----------
mode : FluentMode
Specifies the launch mode of Fluent to target a specific session type.
ui_mode : UIMode
Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
ui_mode : UIMode or str, optional
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
(for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
Expand Down
13 changes: 8 additions & 5 deletions src/ansys/fluent/core/session_utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,9 @@ def from_install(

Parameters
----------
ui_mode : UIMode
Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
ui_mode : UIMode or str, optional
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
(for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
Expand Down Expand Up @@ -194,8 +195,9 @@ def from_container(

Parameters
----------
ui_mode : UIMode
Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
ui_mode : UIMode or str, optional
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
(for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
Expand Down Expand Up @@ -287,7 +289,8 @@ def from_pim(
Parameters
----------
ui_mode : UIMode or str, optional
Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
(for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
Expand Down
Loading