From 6f9f94f32e62b46dc40cb3e8a344101faac9f3e1 Mon Sep 17 00:00:00 2001 From: Prithwish Mukherjee Date: Wed, 17 Sep 2025 13:00:11 +0530 Subject: [PATCH 1/3] docs: Update ReadME --- README.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 924fc21d3c30..bece6754470b 100644 --- a/README.rst +++ b/README.rst @@ -125,21 +125,21 @@ To launch Fluent from Python, use the ``launch_fluent`` function: Basic usage ~~~~~~~~~~~ -You can use the ``solver_session.tui`` interface to run all Fluent TUI commands: +The ``solver_session`` interface provides a convenient way to interact with Fluent: .. code:: python - solver_session.tui.file.read_case('elbow.cas.h5') - solver_session.tui.define.models.unsteady_2nd_order("yes") - solver_session.tui.solve.initialize.initialize_flow() - solver_session.tui.solve.dual_time_iterate(2, 3) + solver_session.settings.file.read_case(file_name="elbow.cas.h5") + solver_session.settings.setup.general.solver.time = "unsteady-2nd-order" + solver_session.settings.solution.initialization.hybrid_initialize() + solver_session.settings.solution.run_calculation.dual_time_iterate( + time_step_count=2, max_iter_per_step=3 + ) -You can also install and use these PyFluent libraries: +For postprocessing and visualization, you can also install: -- `PyFluent Parametric `_, which provides - access to Fluent's parametric workflows. - `PyFluent Visualization `_, which - provides postprocessing and visualization capabilities using the `pyvista `_ + enables analysis and plotting through the `pyvista `_ and `matplotlib `_ packages. License and acknowledgments From a98d887dc62a4aff76d886c2fcd68d75ba54292f Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Wed, 17 Sep 2025 07:32:05 +0000 Subject: [PATCH 2/3] chore: adding changelog file 4477.documentation.md [dependabot-skip] --- doc/changelog.d/4477.documentation.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/4477.documentation.md diff --git a/doc/changelog.d/4477.documentation.md b/doc/changelog.d/4477.documentation.md new file mode 100644 index 000000000000..44a931b6ec72 --- /dev/null +++ b/doc/changelog.d/4477.documentation.md @@ -0,0 +1 @@ +Update ReadME From 36d03b4b35004bc65141bd66b062d31c21eccdb1 Mon Sep 17 00:00:00 2001 From: Prithwish Mukherjee Date: Fri, 19 Sep 2025 13:31:54 +0530 Subject: [PATCH 3/3] Update. --- README.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index bece6754470b..1b9430f2147d 100644 --- a/README.rst +++ b/README.rst @@ -125,16 +125,17 @@ To launch Fluent from Python, use the ``launch_fluent`` function: Basic usage ~~~~~~~~~~~ -The ``solver_session`` interface provides a convenient way to interact with Fluent: +The ``solver_session`` interface provides a convenient way to launch and +interact with Fluent. .. code:: python - solver_session.settings.file.read_case(file_name="elbow.cas.h5") - solver_session.settings.setup.general.solver.time = "unsteady-2nd-order" - solver_session.settings.solution.initialization.hybrid_initialize() - solver_session.settings.solution.run_calculation.dual_time_iterate( - time_step_count=2, max_iter_per_step=3 - ) + import ansys.fluent.core as pyfluent + + solver_session = pyfluent.launch_fluent() + +For more information on using the ``solver_session`` interface, see the +`PyFluent documentation `_. For postprocessing and visualization, you can also install: