fix: example deprecation warnings and improvements #4579

Gobot1234 · 2025-11-03T10:56:24Z

Context

When solver session settings access was deprecated directly on solver the code wasn't updated I've also sprinkled in a couple of small improvements to the examples

Change Summary

Updated all references direct access patterns (solver.setup.models) to the correct settings-based access pattern (solver.settings.setup.models) along with adding PEP 723 styles dependencies to the examples to make them easier to run as standalone scripts.

Rationale

Fixes all the deprecation warnings

Impact

Changes basically everywhere

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

Copilot

Pull Request Overview

This PR fixes deprecation warnings by updating all references from direct solver session settings access (solver.setup.models) to the correct settings-based access pattern (solver.settings.setup.models). Additionally, it adds PEP 723 style dependencies to example scripts and includes minor improvements throughout.

Updates deprecated direct access patterns to settings-based access across all test files and examples
Adds PEP 723 dependency declarations to example scripts for standalone execution
Includes miscellaneous code improvements and cleanups

Reviewed Changes

Copilot reviewed 67 out of 68 changed files in this pull request and generated 4 comments.

File	Description
tests/	Updates test files to use `solver.settings` instead of direct access patterns
examples/	Adds PEP 723 dependency headers and updates deprecated settings access
src/	Updates core library files to use settings-based access pattern
doc/	Updates documentation examples to reflect new access patterns

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

examples/00-fluent/tyler_sofrin_modes.py

examples/00-fluent/modeling_ablation.py

examples/00-fluent/frozen_rotor_workflow.py

Gobot1234 · 2025-11-04T13:35:06Z

Anyone have any opinions on #4512 (review)?

Copilot

Pull request overview

Copilot reviewed 67 out of 68 changed files in this pull request and generated 5 comments.

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

Copilot · 2025-12-02T18:33:03Z

examples/00-fluent/tyler_sofrin_modes.py

    for n_ind, variable in enumerate(varname):
-        if len(variable) >= 4 and variable[:4] == "mean":
-            session.solution.report_definitions.surface["mag-report"] = {
+        if variable.startswith("mean"):


The change from if len(variable) >= 4 and variable[:4] == "mean" to if variable.startswith("mean") is an improvement, but it changes behavior slightly. The original checked for exactly 4 characters before comparing, while startswith() would match any variable starting with "mean" (e.g., "means", "meaningful"). Consider if this behavior change is intentional.

Suggested change

if variable.startswith("mean"):

if len(variable) >= 4 and variable[:4] == "mean":

Copilot · 2025-12-02T18:33:03Z

examples/00-fluent/tyler_sofrin_modes.py

 #######################################################################################
 # Import required libraries/modules
 # =====================================================================================
+import csv


[nitpick] The csv import is added but the code still has a mix of approaches. Consider whether all file I/O should use the csv module consistently throughout the file for better maintainability.

Copilot · 2025-12-02T18:33:03Z

examples/00-fluent/brake.py

 # ---------------------------------------------------------------

-session = pyfluent.launch_fluent(precision="double", processor_count=2, version="3d")
+session = pyfluent.launch_fluent(precision="double", processor_count=2, dimension=3)


The parameter name has been changed from version="3d" to dimension=3. While this is likely a correction, verify that dimension=3 is the correct parameter name for the API, as it significantly changes the meaning (from a version identifier to a dimensional specification).

Suggested change

session = pyfluent.launch_fluent(precision="double", processor_count=2, dimension=3)

session = pyfluent.launch_fluent(precision="double", processor_count=2, solver_mode="3d")

Copilot · 2025-12-02T18:33:04Z

examples/00-fluent/modeling_ablation.py

 solver_session = pyfluent.launch_fluent(
-    dimension=3,
    precision="double",
    processor_count=4,


The dimension=3 parameter was removed from the launch_fluent call. If 3D is the default, this is fine, but if the example specifically requires 3D simulation, removing this parameter could lead to incorrect behavior.

Suggested change

processor_count=4,

processor_count=4,

dimension=3,

Copilot · 2025-12-02T18:33:04Z

examples/00-fluent/DOE_ML.py

    precision="double",
-    processor_count=2,
-    version="3d",
+    processor_count=4,


[nitpick] The processor count was changed from 2 to 4. While this may improve performance, it could cause issues on systems with fewer than 4 processors. Consider documenting this requirement or making it configurable.

Copilot

Pull request overview

Copilot reviewed 67 out of 68 changed files in this pull request and generated 4 comments.

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

Copilot · 2025-12-02T18:48:22Z

tests/test_tui_api.py

-            s.split("\n")[-2].split("(")[0]
-            == r"<solver_session>.settings.file.read_case"
-        )
+        assert s.split("\n")[-2].split("(")[0] == r"<solver_session>.file.read_case"


The assertion on line 69 duplicates the assertion from the conditional on line 68 for versions >= 25.1. Both branches now assert the same expected value (r\"<solver_session>.file.read_case\"), making the conditional check redundant. Consider removing the version check and using a single assertion, or verify if different behavior is expected for different versions.

examples/00-fluent/tyler_sofrin_modes.py

tests/parametric/test_parametric_workflow.py

Copilot · 2025-12-02T18:48:23Z

tests/parametric/test_parametric_workflow.py


-    create_output_param = solver_session.tui.define.parameters.output_parameters.create
+    create_output_param = (
+        solver_session.tui.define.settings.parameters.output_parameters.create


The TUI path has been changed from tui.define.parameters.output_parameters.create to tui.define.settings.parameters.output_parameters.create, adding an extra settings level. Verify this is the correct TUI command path, as incorrect TUI paths will cause runtime errors.

Copilot

Pull request overview

Copilot reviewed 67 out of 68 changed files in this pull request and generated 5 comments.

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

Copilot · 2025-12-02T18:58:15Z

examples/00-fluent/tyler_sofrin_modes.py

 #######################################################################################
 # Import required libraries/modules
 # =====================================================================================
+import csv


[nitpick] The import statement for 'csv' has been added but 'open' is being replaced with 'Path.cwd().open()'. Consider moving the csv import closer to where it's used (line 247) for better code organization, or ensure the import order follows PEP 8 guidelines (standard library imports together).

Copilot · 2025-12-02T18:58:16Z

examples/00-fluent/modeling_ablation.py

 ####################################################################################
 # Launch Fluent session with solver mode and print Fluent version
 # ==================================================================================



[nitpick] The dimension=3 parameter was removed from the launch_fluent call. If this was intentional because 3D is the default, consider adding a comment explaining this for clarity, as the removal might confuse future readers.

Suggested change

# Note: The 'dimension=3' parameter is omitted because 3D is the default for launch_fluent.

Copilot · 2025-12-02T18:58:16Z

examples/00-fluent/external_compressible_flow.py

        "FileName": wing_intermediary_file,
    }
 )



The line meshing_session.upload(wing_intermediary_file) was removed before geo_import.Execute(). Ensure that the file upload is no longer needed or is handled elsewhere in the workflow, as this could cause the import to fail if the file is not available.

Suggested change

meshing_session.upload(wing_intermediary_file)

Copilot · 2025-12-02T18:58:16Z

examples/00-fluent/exhaust_system_settings_api.py

 # parts.

-meshing_session.upload(import_file_name)
 meshing_session.PartManagement.InputFileChanged(


Similar to the previous comment, meshing_session.upload(import_file_name) was removed. Verify that the file upload is handled elsewhere or is no longer required for the workflow to function correctly.

Copilot · 2025-12-02T18:58:17Z

examples/00-fluent/DOE_ML.py

 #################################################################
 # Launch Fluent session with solver mode and print Fluent version
 # ===============================================================



[nitpick] The processor count was changed from 2 to 4, and version=\"3d\" was removed. Document or verify that this change in processor count is intentional and appropriate for the example's resource requirements.

Suggested change

# The processor count is set to 4 to provide sufficient computational resources

# for the DOE and ML example, which can benefit from parallel processing.

# The default solver version is "3d", so the explicit version argument was removed.

# Adjust processor_count as needed for your hardware.

Copilot

Pull request overview

Copilot reviewed 67 out of 68 changed files in this pull request and generated 3 comments.

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

Copilot · 2025-12-02T19:03:25Z

examples/00-fluent/exhaust_system_settings_api.py

+graphics.views.camera.position = [1.70, 1.14, 0.29]
+graphics.views.camera.up_vector = [-0.66, 0.72, -0.20]


The camera position and up_vector are now set using direct assignment instead of method calls (.position() and .up_vector()). Verify that the settings API supports direct assignment for these properties and that the behavior is equivalent.

Suggested change

graphics.views.camera.position = [1.70, 1.14, 0.29]

graphics.views.camera.up_vector = [-0.66, 0.72, -0.20]

graphics.views.camera.position([1.70, 1.14, 0.29])

graphics.views.camera.up_vector([-0.66, 0.72, -0.20])

Copilot · 2025-12-02T19:03:25Z

examples/00-fluent/conjugate_heat_transfer.py

    mode="meshing",
-    dimension=3,
    precision="double",
    processor_count=4,
 )


The dimension=3 parameter was removed from launch_fluent. Ensure the default dimension setting is appropriate for this conjugate heat transfer case.

Copilot · 2025-12-02T19:03:26Z

tests/parametric/test_parametric_workflow.py

-    solver_session.file.read_case(file_name=import_file_name)
-    solver_session.solution.run_calculation.iter_count = 100
+    solver_session.settings.file.read_case(file_name=import_file_name)
+    solver_session.settings.solution.run_calculation.parameters.iter_count = 100


The iter_count assignment was changed from solver_session.settings.solution.run_calculation.iter_count to solver_session.settings.solution.run_calculation.parameters.iter_count. Verify this is the correct path for setting iteration count in the parametric workflow context.

Suggested change

solver_session.settings.solution.run_calculation.parameters.iter_count = 100

solver_session.settings.solution.run_calculation.iter_count = 100

Gobot1234 and others added 15 commits October 7, 2025 11:13

Add type level support for passing Path instances to download_file

005b37a

Pre-emptively fix isort

a41b780

Fix black

e06bbbd

fix: solver session settings access in tests and examples

79beceb

revert: some of the broken updates

a9d95d3

chore: add acronym for DOE

c3fc60e

Move the boundary layer update

376508f

Apply suggestion from @Gobot1234

0063e0c

Fix some review issues

a6c1804

Merge branch 'main' into example-updates

0aa7841

Fix typo

9e02c58

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

fix: old syntax for camera position

5f9fd49

refactor: make the code more pythonic

e101c51

Merge branch 'main' into example-updates

313b069

fix ci

2343b7a

Copilot AI review requested due to automatic review settings November 3, 2025 10:56

Gobot1234 requested review from hpohekar, mayankansys, mkundu1, prmukherj and seanpearsonuk as code owners November 3, 2025 10:56

github-actions bot added documentation Documentation related (improving, adding, etc) examples Publishing PyFluent examples bug Issue, problem or error in PyFluent labels Nov 3, 2025

Gobot1234 mentioned this pull request Nov 3, 2025

fix: example deprecation warnings and improvements #4512

Closed

chore: adding changelog file 4579.fixed.md [dependabot-skip]

c8a59db

Copilot AI reviewed Nov 3, 2025

View reviewed changes

examples/00-fluent/tyler_sofrin_modes.py Show resolved Hide resolved

examples/00-fluent/tyler_sofrin_modes.py Show resolved Hide resolved

examples/00-fluent/modeling_ablation.py Show resolved Hide resolved

examples/00-fluent/frozen_rotor_workflow.py Show resolved Hide resolved

mkundu1 approved these changes Nov 3, 2025

View reviewed changes

hpohekar approved these changes Nov 4, 2025

View reviewed changes

Adda couple of missed deprecations

ebc90ce

prmukherj approved these changes Nov 21, 2025

View reviewed changes

Merge branch 'main' into jhilton-/example-updates

af2156f

Copilot AI review requested due to automatic review settings December 2, 2025 18:31

Copilot AI reviewed Dec 2, 2025

View reviewed changes

fmt

5b0326f

Copilot AI review requested due to automatic review settings December 2, 2025 18:47

Copilot AI reviewed Dec 2, 2025

View reviewed changes

oops

701650b

Copilot AI review requested due to automatic review settings December 2, 2025 18:56

Copilot AI reviewed Dec 2, 2025

View reviewed changes

fix tui change

4f8fa85

Copilot AI review requested due to automatic review settings December 2, 2025 19:01

Copilot AI reviewed Dec 2, 2025

View reviewed changes

	if variable.startswith("mean"):
	if len(variable) >= 4 and variable[:4] == "mean":

	session = pyfluent.launch_fluent(precision="double", processor_count=2, dimension=3)
	session = pyfluent.launch_fluent(precision="double", processor_count=2, solver_mode="3d")



	# Note: The 'dimension=3' parameter is omitted because 3D is the default for launch_fluent.

+# The processor count is set to 4 to provide sufficient computational resources
+# for the DOE and ML example, which can benefit from parallel processing.
+# The default solver version is "3d", so the explicit version argument was removed.
+# Adjust processor_count as needed for your hardware.

		graphics.views.camera.position = [1.70, 1.14, 0.29]
		graphics.views.camera.up_vector = [-0.66, 0.72, -0.20]

	solver_session.settings.solution.run_calculation.parameters.iter_count = 100
	solver_session.settings.solution.run_calculation.iter_count = 100

fix: example deprecation warnings and improvements #4579

Are you sure you want to change the base?

fix: example deprecation warnings and improvements #4579

Conversation

Gobot1234 commented Nov 3, 2025

Context

Change Summary

Rationale

Impact

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Gobot1234 commented Nov 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

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!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 2, 2025

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!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

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!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment