diff --git a/README.rst b/README.rst index 924fc21d3c3..1b9430f2147 100644 --- a/README.rst +++ b/README.rst @@ -125,21 +125,22 @@ 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 launch and +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) + import ansys.fluent.core as pyfluent + + solver_session = pyfluent.launch_fluent() + +For more information on using the ``solver_session`` interface, see the +`PyFluent documentation `_. -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 diff --git a/doc/changelog.d/4477.documentation.md b/doc/changelog.d/4477.documentation.md new file mode 100644 index 00000000000..44a931b6ec7 --- /dev/null +++ b/doc/changelog.d/4477.documentation.md @@ -0,0 +1 @@ +Update ReadME