ansys-fluent-visualization 0.22.dev0__tar.gz → 0.22.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/PKG-INFO +27 -12
  2. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/README.rst +21 -8
  3. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/pyproject.toml +4 -4
  4. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/post_objects/check_in_notebook.py +1 -3
  5. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/__init__.py +1 -1
  6. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/containers.py +21 -18
  7. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/AUTHORS +0 -0
  8. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/LICENSE +0 -0
  9. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/__init__.py +0 -0
  10. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/post_objects/__init__.py +0 -0
  11. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/post_objects/meta.py +0 -0
  12. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/post_objects/post_helper.py +0 -0
  13. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/post_objects/post_object_definitions.py +0 -0
  14. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/post_objects/post_objects_container.py +0 -0
  15. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/interface/post_objects/singleton_meta.py +0 -0
  16. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/base/__init__.py +0 -0
  17. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/base/renderer.py +0 -0
  18. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/config.py +0 -0
  19. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/contour.py +0 -0
  20. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/graphics/__init__.py +0 -0
  21. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/graphics/graphics_objects.py +0 -0
  22. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/graphics/graphics_windows.py +0 -0
  23. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/graphics/graphics_windows_manager.py +0 -0
  24. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/graphics/pyvista/__init__.py +0 -0
  25. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/graphics/pyvista/renderer.py +0 -0
  26. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/graphics/single_qt_windows.py +0 -0
  27. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/matplotlib/__init__.py +0 -0
  28. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/__init__.py +0 -0
  29. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/matplotlib/__init__.py +0 -0
  30. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/matplotlib/renderer.py +0 -0
  31. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/plotter_objects.py +0 -0
  32. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/plotter_windows.py +0 -0
  33. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/plotter_windows_manager.py +0 -0
  34. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/pyvista/__init__.py +0 -0
  35. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/plotter/pyvista/renderer.py +0 -0
  36. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/post_data_extractor.py +0 -0
  37. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/pyvista/__init__.py +0 -0
  38. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/registrar.py +0 -0
  39. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/renderer.py +0 -0
  40. {ansys_fluent_visualization-0.22.dev0 → ansys_fluent_visualization-0.22.1}/src/ansys/fluent/visualization/visualization_windows_manager.py +0 -0
@@ -1,13 +1,15 @@
1
- Metadata-Version: 2.3
1
+ Metadata-Version: 2.4
2
2
  Name: ansys-fluent-visualization
3
- Version: 0.22.dev0
3
+ Version: 0.22.1
4
4
  Summary: A python wrapper for ansys Fluent visualization
5
5
  License: MIT
6
+ License-File: AUTHORS
7
+ License-File: LICENSE
6
8
  Author: ANSYS, Inc.
7
9
  Author-email: ansys.support@ansys.com
8
10
  Maintainer: PyAnsys developers
9
11
  Maintainer-email: pyansys.maintainers@ansys.com
10
- Requires-Python: >=3.10,<4.0
12
+ Requires-Python: >=3.10,<3.14
11
13
  Classifier: Development Status :: 4 - Beta
12
14
  Classifier: License :: OSI Approved :: MIT License
13
15
  Classifier: Operating System :: OS Independent
@@ -18,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.12
18
20
  Classifier: Programming Language :: Python :: 3.13
19
21
  Provides-Extra: interactive
20
22
  Provides-Extra: single-window
21
- Requires-Dist: ansys-fluent-core (>=0.35.dev0,<1.0)
23
+ Requires-Dist: ansys-fluent-core (>=0.35.0,<0.36.0)
22
24
  Requires-Dist: importlib-metadata (>=4.0,<5.0) ; python_version < "3.9"
23
25
  Requires-Dist: matplotlib (>=3.6.0)
24
26
  Requires-Dist: pyside6 (>=6.8.1,<6.9.0) ; extra == "single-window"
@@ -32,12 +34,16 @@ Description-Content-Type: text/x-rst
32
34
 
33
35
  PyFluent-Visualization
34
36
  ======================
35
- |pyansys| |pypi| |GH-CI| |MIT| |black| |pre-commit|
37
+ |pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| |pre-commit|
36
38
 
37
39
  .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
38
40
  :target: https://docs.pyansys.com/
39
41
  :alt: PyAnsys
40
42
 
43
+ .. |python| image:: https://img.shields.io/pypi/pyversions/ansys-fluent-core?logo=pypi
44
+ :target: https://pypi.org/project/ansys-fluent-visualizaion/
45
+ :alt: Python
46
+
41
47
  .. |pypi| image:: https://img.shields.io/pypi/v/ansys-fluent-visualization.svg?logo=python&logoColor=white
42
48
  :target: https://pypi.org/project/ansys-fluent-visualization
43
49
  :alt: PyPI
@@ -46,6 +52,9 @@ PyFluent-Visualization
46
52
  :target: https://github.com/ansys/pyfluent-visualization/actions/workflows/ci_cd.yml
47
53
  :alt: GH-CI
48
54
 
55
+ .. |codecov| image:: https://codecov.io/gh/ansys/pyfluent-visualization/branch/main/graph/badge.svg
56
+ :target: https://codecov.io/gh/ansys/pyfluent-visualization
57
+
49
58
  .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
50
59
  :target: https://opensource.org/licenses/MIT
51
60
  :alt: MIT
@@ -141,17 +150,23 @@ Basic usage
141
150
  The following code assumes that a PyFluent session has already been created
142
151
  and a Fluent case with input parameters has been set up. For a complete
143
152
  example, see `Analyzing your results
144
- <https://fluentvisualization.docs.pyansys.com/users_guide/postprocessing.html>`_ in
153
+ <https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html>`_ in
145
154
  the PyFluent-Visualization documentation.
146
155
 
147
156
  .. code:: python
148
157
 
149
- from ansys.fluent.visualization import Graphics
150
- graphics = Graphics(session=session)
151
- temperature_contour = graphics.Contours["contour-temperature"]
152
- temperature_contour.field = "temperature"
153
- temperature_contour.surfaces = ["in1", "in2", "out1"]
154
- temperature_contour.display("window-1")
158
+ from ansys.fluent.visualization import Contour, GraphicsWindow
159
+ from ansys.fluent.core.solver import VelocityInlets, PressureOutlets, using
160
+ from ansys.units import VariableCatalog
161
+
162
+ graphics_window = GraphicsWindow()
163
+
164
+ # Use an existing PyFluent solver session for the duration of this block
165
+ with using(solver_session):
166
+ # Define a contour plot of static pressure across all velocity inlets and pressure outlets
167
+ pressure_contour = Contour(field=VariableCatalog.STATIC_PRESSURE, surfaces=VelocityInlets() + PressureOutlets())
168
+ graphics_window.add_graphics(pressure_contour)
169
+ graphics_window.show()
155
170
 
156
171
  Usage in a JupyterLab environment
157
172
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1,11 +1,15 @@
1
1
  PyFluent-Visualization
2
2
  ======================
3
- |pyansys| |pypi| |GH-CI| |MIT| |black| |pre-commit|
3
+ |pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| |pre-commit|
4
4
 
5
5
  .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
6
6
  :target: https://docs.pyansys.com/
7
7
  :alt: PyAnsys
8
8
 
9
+ .. |python| image:: https://img.shields.io/pypi/pyversions/ansys-fluent-core?logo=pypi
10
+ :target: https://pypi.org/project/ansys-fluent-visualizaion/
11
+ :alt: Python
12
+
9
13
  .. |pypi| image:: https://img.shields.io/pypi/v/ansys-fluent-visualization.svg?logo=python&logoColor=white
10
14
  :target: https://pypi.org/project/ansys-fluent-visualization
11
15
  :alt: PyPI
@@ -14,6 +18,9 @@ PyFluent-Visualization
14
18
  :target: https://github.com/ansys/pyfluent-visualization/actions/workflows/ci_cd.yml
15
19
  :alt: GH-CI
16
20
 
21
+ .. |codecov| image:: https://codecov.io/gh/ansys/pyfluent-visualization/branch/main/graph/badge.svg
22
+ :target: https://codecov.io/gh/ansys/pyfluent-visualization
23
+
17
24
  .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
18
25
  :target: https://opensource.org/licenses/MIT
19
26
  :alt: MIT
@@ -109,17 +116,23 @@ Basic usage
109
116
  The following code assumes that a PyFluent session has already been created
110
117
  and a Fluent case with input parameters has been set up. For a complete
111
118
  example, see `Analyzing your results
112
- <https://fluentvisualization.docs.pyansys.com/users_guide/postprocessing.html>`_ in
119
+ <https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html>`_ in
113
120
  the PyFluent-Visualization documentation.
114
121
 
115
122
  .. code:: python
116
123
 
117
- from ansys.fluent.visualization import Graphics
118
- graphics = Graphics(session=session)
119
- temperature_contour = graphics.Contours["contour-temperature"]
120
- temperature_contour.field = "temperature"
121
- temperature_contour.surfaces = ["in1", "in2", "out1"]
122
- temperature_contour.display("window-1")
124
+ from ansys.fluent.visualization import Contour, GraphicsWindow
125
+ from ansys.fluent.core.solver import VelocityInlets, PressureOutlets, using
126
+ from ansys.units import VariableCatalog
127
+
128
+ graphics_window = GraphicsWindow()
129
+
130
+ # Use an existing PyFluent solver session for the duration of this block
131
+ with using(solver_session):
132
+ # Define a contour plot of static pressure across all velocity inlets and pressure outlets
133
+ pressure_contour = Contour(field=VariableCatalog.STATIC_PRESSURE, surfaces=VelocityInlets() + PressureOutlets())
134
+ graphics_window.add_graphics(pressure_contour)
135
+ graphics_window.show()
123
136
 
124
137
  Usage in a JupyterLab environment
125
138
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
5
5
  [tool.poetry]
6
6
  # Check https://python-poetry.org/docs/pyproject/ for all available sections
7
7
  name = "ansys-fluent-visualization"
8
- version = "0.22.dev0"
8
+ version = "0.22.1"
9
9
  description = "A python wrapper for ansys Fluent visualization"
10
10
  license = "MIT"
11
11
  authors = ["ANSYS, Inc. <ansys.support@ansys.com>"]
@@ -23,9 +23,9 @@ packages = [
23
23
  ]
24
24
 
25
25
  [tool.poetry.dependencies]
26
- python = ">=3.10,<4.0"
26
+ python = ">=3.10,<3.14"
27
27
  importlib-metadata = {version = "^4.0", python = "<3.9"}
28
- ansys-fluent-core = "~=0.35.dev0"
28
+ ansys-fluent-core = "~=0.35.0"
29
29
  pyvista = ">=0.44.0"
30
30
  matplotlib = ">=3.6.0"
31
31
  pyvistaqt = { version = "~=0.11.1", optional = true }
@@ -51,7 +51,7 @@ default_section = "THIRDPARTY"
51
51
  src_paths = ["doc", "src", "tests"]
52
52
 
53
53
  [tool.coverage.run]
54
- source = ["ansys.fluent"]
54
+ source = ["ansys/fluent"]
55
55
 
56
56
  [tool.coverage.report]
57
57
  show_missing = true
@@ -31,11 +31,9 @@ def in_jupyter():
31
31
  try:
32
32
  from IPython import get_ipython
33
33
 
34
- if "IPKernelApp" not in get_ipython().config:
35
- return False
34
+ return "IPKernelApp" in get_ipython().config
36
35
  except (ImportError, AttributeError):
37
36
  return False
38
- return True
39
37
 
40
38
 
41
39
  def in_notebook():
@@ -27,7 +27,7 @@ try:
27
27
  except ModuleNotFoundError:
28
28
  import importlib_metadata
29
29
 
30
- _VERSION_INFO = "Build date: August 12, 2025 07:23 UTC ShaID: 897e757"
30
+ _VERSION_INFO = "Build date: September 19, 2025 10:14 UTC ShaID: f20236b"
31
31
  __version__ = importlib_metadata.version(__name__.replace(".", "-"))
32
32
 
33
33
 
@@ -139,13 +139,16 @@ class Surface(_GraphicsContainer):
139
139
  elif attr == "creation_method":
140
140
  self._obj.definition.plane_surface.creation_method = value
141
141
  elif attr == "z":
142
- assert self._obj.definition.plane_surface.creation_method() == "xy-plane"
142
+ if self._obj.definition.plane_surface.creation_method() != "xy-plane":
143
+ raise ValueError("Expected plane creation method to be 'xy-plane'")
143
144
  self._obj.definition.plane_surface.xy_plane.z = value
144
145
  elif attr == "y":
145
- assert self._obj.definition.plane_surface.creation_method() == "zx-plane"
146
+ if self._obj.definition.plane_surface.creation_method() != "zx-plane":
147
+ raise ValueError("Expected plane creation method to be 'zx-plane'")
146
148
  self._obj.definition.plane_surface.zx_plane.y = value
147
149
  elif attr == "x":
148
- assert self._obj.definition.plane_surface.creation_method() == "yz-plane"
150
+ if self._obj.definition.plane_surface.creation_method() != "yz-plane":
151
+ raise ValueError("Expected plane creation method to be 'yz-plane'")
149
152
  self._obj.definition.plane_surface.yz_plane.x = value
150
153
  elif attr == "field":
151
154
  self._obj.definition.iso_surface.field = _to_field_name_str(value)
@@ -153,22 +156,22 @@ class Surface(_GraphicsContainer):
153
156
  self._obj.definition.iso_surface.iso_value = value
154
157
  elif attr == "rendering":
155
158
  self._obj.definition.iso_surface.rendering = value
156
- elif attr == "point":
157
- assert (
159
+ elif attr in ["point", "normal"]:
160
+ if (
158
161
  self._obj.definition.plane_surface.creation_method()
159
- == "point-and-normal"
160
- )
161
- self._obj.definition.plane_surface.point.x = value[0]
162
- self._obj.definition.plane_surface.point.y = value[1]
163
- self._obj.definition.plane_surface.point.z = value[2]
164
- elif attr == "normal":
165
- assert (
166
- self._obj.definition.plane_surface.creation_method()
167
- == "point-and-normal"
168
- )
169
- self._obj.definition.plane_surface.normal.x = value[0]
170
- self._obj.definition.plane_surface.normal.y = value[1]
171
- self._obj.definition.plane_surface.normal.z = value[2]
162
+ != "point-and-normal"
163
+ ):
164
+ raise ValueError(
165
+ "Expected plane creation method to be 'point-and-normal'"
166
+ )
167
+ if attr == "point":
168
+ self._obj.definition.plane_surface.point.x = value[0]
169
+ self._obj.definition.plane_surface.point.y = value[1]
170
+ self._obj.definition.plane_surface.point.z = value[2]
171
+ elif attr == "normal":
172
+ self._obj.definition.plane_surface.normal.x = value[0]
173
+ self._obj.definition.plane_surface.normal.y = value[1]
174
+ self._obj.definition.plane_surface.normal.z = value[2]
172
175
  else:
173
176
  setattr(self._obj, attr, value)
174
177