docs: updated the session file [skip tests] by mayankansys · Pull Request #5005 · ansys/pyfluent

mayankansys · 2026-03-20T06:41:59Z

Context

The session user guide was outdated.

It still showed launch_fluent() as the main way to create sessions, while the recommended style is now <session-type>.from_<...>(...).

Change Summary

Updated the session documentation to use the newer session creation style in examples and explanations.
Also fixed related wording in the session exit section so it matches current API behavior.
Changes were made in session.rst.

Rationale

This keeps the docs aligned with current best practice and reduces confusion for new users.
Users now see the recommended API first, with older lower-level functions shown as alternatives.

Impact

Affects user-facing documentation only.

Copilot

Pull request overview

Updates the PyFluent “Using sessions” user guide to reflect the recommended session-creation pattern (<session-type>.from_<...>(...)) rather than primarily documenting launch_fluent().

Changes:

Replaced launch_fluent()-based examples with Solver/Meshing/PureMeshing.from_install() examples.
Added guidance that launch_fluent() / connect_to_fluent() are lower-level alternatives and clarified exit/cleanup behavior.
Updated multi-session and garbage-collection examples to use the newer APIs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-20T06:45:00Z

 Each Fluent session terminates in this scenario because both PyFluent :ref:`Session <ref_session_guide>` objects were obtained by
-calling the :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>` function. If the :func:`connect_to_fluent() <ansys.fluent.core.launcher.launcher.connect_to_fluent>` function were used instead, the
-Fluent session would terminate upon the ``exit()`` method call if and only if the :func:`connect_to_fluent() <ansys.fluent.core.launcher.launcher.connect_to_fluent>`
-function were called with the argument value ``cleanup_on_exit=True``.
+using a ``from_<...>`` launch method (for example, :meth:`from_install() <ansys.fluent.core.session_utilities.SessionBase.from_install>`).
+If :meth:`from_connection() <ansys.fluent.core.session_utilities.SessionBase.from_connection>` were used instead, the
+Fluent session would not be terminated upon ``exit()`` by default.
+For configurable cleanup behavior when attaching to an existing Fluent process,
+use :func:`connect_to_fluent() <ansys.fluent.core.launcher.launcher.connect_to_fluent>`
+directly with its ``cleanup_on_exit`` parameter.


This paragraph clarifies that from_connection() / connect_to_fluent() (default cleanup_on_exit=False) won’t terminate Fluent on exit(), but the preceding sentence in this section still states that calling exit() terminates the connected Fluent sessions. Consider adjusting that earlier sentence to avoid implying termination is unconditional, and instead describe termination as dependent on cleanup_on_exit / launch method.

@mayankansys good point above

codacy-production · 2026-04-01T04:45:14Z

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

_{TIP This summary will be updated as you push new changes. Give us feedback}

…ansys/pyfluent into docs/session_rst_out_dated_4945

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-09T07:38:42Z

@@ -0,0 +1 @@
+Updated the session file


This changelog entry is too vague to be useful in release notes. Please describe the user-visible documentation change more specifically (e.g., that session guide examples now use <session>.from_install()/from_container()/from_connection() rather than launch_fluent()), ideally as a complete sentence with a period to match nearby entries.

Suggested change

Updated the session file

Updated the session guide examples to use ``<session>.from_install()/from_container()/from_connection()`` instead of ``launch_fluent()``.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

seanpearsonuk · 2026-04-09T11:06:14Z


-You can obtain a PyFluent session object by calling either of the functions, :func:`launch_fluent()
-<ansys.fluent.core.launcher.launcher.launch_fluent>` or :func:`connect_to_fluent() <ansys.fluent.core.launcher.launcher.connect_to_fluent>`. 
+The encouraged way to create a PyFluent session is to use the ``from_<...>`` class methods on a session type, for


Suggested change

The encouraged way to create a PyFluent session is to use the ``from_<...>`` class methods on a session type, for

The recommended way to create a PyFluent session is to use the ``from_<...>`` class methods on a session type, for

Alternatively, we could omit that clause and launch straight into "Create a PyFluent session using the from_<...> class methods...". I think I prefer that.

updated the session file

c8832f9

mayankansys requested review from hpohekar, mkundu1, prmukherj and seanpearsonuk as code owners March 20, 2026 06:42

Copilot AI review requested due to automatic review settings March 20, 2026 06:42

mayankansys marked this pull request as draft March 20, 2026 06:42

github-actions bot added the documentation Documentation related (improving, adding, etc) label Mar 20, 2026

Copilot started reviewing on behalf of mayankansys March 20, 2026 06:42 View session

mayankansys changed the title ~~updated the session file~~ docs: updated the session file Mar 20, 2026

chore: adding changelog file 5005.documentation.md [dependabot-skip]

042f7d4

Copilot AI reviewed Mar 20, 2026

View reviewed changes

mayankansys linked an issue Mar 20, 2026 that may be closed by this pull request

session.rst is out of date wrt session creation #4945

Open

mayankansys added 4 commits March 23, 2026 14:39

Merge branch 'main' into docs/session_rst_out_dated_4945

564ade0

Merge branch 'main' into docs/session_rst_out_dated_4945

790f27d

Merge branch 'main' into docs/session_rst_out_dated_4945

1e41abd

Merge branch 'main' into docs/session_rst_out_dated_4945

6ad26f0

mayankansys added 3 commits April 6, 2026 13:07

Merge branch 'main' into docs/session_rst_out_dated_4945

feabe97

updated

d226da5

Merge branch 'docs/session_rst_out_dated_4945' of https://github.com/…

e96b6be

…ansys/pyfluent into docs/session_rst_out_dated_4945

github-actions bot added maintenance General maintenance of the repo (libraries, cicd, etc) dependencies Related to dependencies labels Apr 9, 2026

mayankansys added 4 commits April 9, 2026 12:42

update

2b5d183

updated rstgen

458c256

update

4401436

Merge branch 'main' into docs/session_rst_out_dated_4945

40fefcb

mayankansys marked this pull request as ready for review April 9, 2026 07:34

Copilot AI review requested due to automatic review settings April 9, 2026 07:34

Copilot started reviewing on behalf of mayankansys April 9, 2026 07:35 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

Update doc/source/user_guide/session/session.rst

71ebf22

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 9, 2026 09:07

Copilot AI reviewed Apr 9, 2026

View reviewed changes

seanpearsonuk reviewed Apr 9, 2026

View reviewed changes

mayankansys changed the title ~~docs: updated the session file~~ docs: updated the session file [skip tests] Apr 9, 2026

chore: adding changelog file 5005.documentation.md [dependabot-skip]

f9da2b6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: updated the session file [skip tests]#5005

docs: updated the session file [skip tests]#5005
mayankansys wants to merge 15 commits intomainfrom
docs/session_rst_out_dated_4945

mayankansys commented Mar 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 20, 2026

Uh oh!

seanpearsonuk Apr 9, 2026

Uh oh!

Uh oh!

codacy-production bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Apr 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

seanpearsonuk Apr 9, 2026

Uh oh!

mayankansys Apr 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	Updated the session file
	Updated the session guide examples to use ``<session>.from_install()/from_container()/from_connection()`` instead of ``launch_fluent()``.

	The encouraged way to create a PyFluent session is to use the ``from_<...>`` class methods on a session type, for
	The recommended way to create a PyFluent session is to use the ``from_<...>`` class methods on a session type, for

Conversation

mayankansys commented Mar 20, 2026

Context

Change Summary

Rationale

Impact

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

seanpearsonuk Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codacy-production bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Up to standards ✅

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

seanpearsonuk Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

mayankansys Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codacy-production bot commented Apr 1, 2026 •

edited

Loading