diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 83878387..418ab6e1 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -105,8 +105,8 @@ jobs: - name: Retrieve pyfluent-visualization version run: | - echo "::set-output name=PYFLUENT_VISUALIZATION_VERSION::$(python -c "from ansys.fluent.post import __version__; print(__version__)")" - echo "pyfluent-visualization version is: $(python -c "from ansys.fluent.post import __version__; print(__version__)")" + echo "::set-output name=PYFLUENT_VISUALIZATION_VERSION::$(python -c "from ansys.fluent.visualization import __version__; print(__version__)")" + echo "pyfluent-visualization version is: $(python -c "from ansys.fluent.visualization import __version__; print(__version__)")" id: version - name: Cache examples diff --git a/Makefile b/Makefile index f76d6cbb..d8e4b1a1 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ install: @python -m pip install --upgrade pip poetry @python -m pip install -r requirements/requirements_build.txt @poetry build - @pip install dist/ansys*.whl + @pip install dist/ansys*.whl --force-reinstall docker-pull: @pip install docker diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index 9b3b5306..c8295b77 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -14,4 +14,4 @@ Here we should discuss the different API modules at a high level. :maxdepth: 4 :hidden: - post/index \ No newline at end of file + visualization/index \ No newline at end of file diff --git a/doc/source/api/post/index.rst b/doc/source/api/visualization/index.rst similarity index 95% rename from doc/source/api/post/index.rst rename to doc/source/api/visualization/index.rst index aef0378c..b7bf2f1a 100644 --- a/doc/source/api/post/index.rst +++ b/doc/source/api/visualization/index.rst @@ -32,7 +32,7 @@ environment and PyVista is used to visualze the extracted data. .. code:: python # import module - from ansys.fluent.post.pyvista import Graphics + from ansys.fluent.visualization.pyvista import Graphics # get the graphics objects for the session @@ -90,7 +90,7 @@ environment and data is plotted in MatplotLib. .. code:: python # import module - from ansys.fluent.post.matplotlib import Plots + from ansys.fluent.visualization.matplotlib import Plots # get the plots object for the session plots_session1 = Plots(session) @@ -107,7 +107,7 @@ environment and data is plotted in MatplotLib. session.exit() -.. currentmodule:: ansys.fluent.post +.. currentmodule:: ansys.fluent.visualization .. autosummary:: :toctree: _autosummary diff --git a/doc/source/api/post/pyvista_objects.rst b/doc/source/api/visualization/pyvista_objects.rst similarity index 66% rename from doc/source/api/post/pyvista_objects.rst rename to doc/source/api/visualization/pyvista_objects.rst index 6c9961fd..ff645a9a 100644 --- a/doc/source/api/post/pyvista_objects.rst +++ b/doc/source/api/visualization/pyvista_objects.rst @@ -2,7 +2,7 @@ Graphics ======== -.. currentmodule:: ansys.fluent.post.pyvista.pyvista_objects +.. currentmodule:: ansys.fluent.visualization.pyvista.pyvista_objects .. autosummary:: :toctree: _autosummary diff --git a/doc/source/conf.py b/doc/source/conf.py index 30553444..4417532f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -10,7 +10,7 @@ import pyvista from sphinx_gallery.sorting import FileNameSortKey -from ansys.fluent.post import __version__ +from ansys.fluent.visualization import __version__ # Manage errors pyvista.set_error_output_file("errors.txt") @@ -198,7 +198,7 @@ def _stop_fluent_container(gallery_conf, fname): ( master_doc, f"pyfluent-visualization-Documentation-{__version__}.tex", - "ansys.fluent.post Documentation", + "ansys.fluent.visualization Documentation", author, "manual", ), @@ -212,8 +212,8 @@ def _stop_fluent_container(gallery_conf, fname): man_pages = [ ( master_doc, - "ansys.fluent.post", - "ansys.fluent.post Documentation", + "ansys.fluent.visualization", + "ansys.fluent.visualization Documentation", [author], 1, ) @@ -228,10 +228,10 @@ def _stop_fluent_container(gallery_conf, fname): texinfo_documents = [ ( master_doc, - "ansys.fluent.post", - "ansys.fluent.post Documentation", + "ansys.fluent.visualization", + "ansys.fluent.visualization Documentation", author, - "ansys.fluent.post", + "ansys.fluent.visualization", "Pythonic interface for Fluent using gRPC", "Engineering Software", ), diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 18d846b7..2271127d 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -23,7 +23,6 @@ mode: cd pyfluent pip install pip -U pip install -e . - pip install -e .[post] # If you want to use pyvista Building Documentation ---------------------- diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index cce9ef0f..f4359ba3 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -66,7 +66,7 @@ You can launch Fluent from Python using the ``launch_fluent`` function: session.check_health() session.start_transcript() # Streaming the transcript locally -The ``post`` package provides integrations with both +The ``visualization`` package provides integrations with both ``pyvista`` and ``matplotlib``. If you want to interact with the Fluent graphical user interface, set the diff --git a/doc/source/users_guide/postprocessing.rst b/doc/source/users_guide/postprocessing.rst index 18a4309a..da29ecb7 100644 --- a/doc/source/users_guide/postprocessing.rst +++ b/doc/source/users_guide/postprocessing.rst @@ -4,7 +4,7 @@ PyFluent postprocessing supports graphics and plotting. Rendering Graphics Objects -------------------------- -The post package library is used for rendering graphics objects. +The visualization package library is used for rendering graphics objects. The following graphics operations are supported. Displaying Mesh Objects @@ -15,9 +15,9 @@ The following example demonstrates how you can display the mesh object: import ansys.fluent.core as pyfluent from ansys.fluent.core import examples - from ansys.fluent.post import set_config - from ansys.fluent.post.matplotlib import Plots - from ansys.fluent.post.pyvista import Graphics + from ansys.fluent.visualization import set_config + from ansys.fluent.visualization.matplotlib import Plots + from ansys.fluent.visualization.pyvista import Graphics set_config(blocking=True, set_view_on_display="isometric") diff --git a/examples/00-postprocessing/post_processing_exhaust_manifold.py b/examples/00-postprocessing/post_processing_exhaust_manifold.py index 7e15bd39..ca5babf9 100644 --- a/examples/00-postprocessing/post_processing_exhaust_manifold.py +++ b/examples/00-postprocessing/post_processing_exhaust_manifold.py @@ -21,9 +21,9 @@ import ansys.fluent.core as pyfluent from ansys.fluent.core import examples -from ansys.fluent.post import set_config -from ansys.fluent.post.matplotlib import Plots -from ansys.fluent.post.pyvista import Graphics +from ansys.fluent.visualization import set_config +from ansys.fluent.visualization.matplotlib import Plots +from ansys.fluent.visualization.pyvista import Graphics set_config(blocking=True, set_view_on_display="isometric") diff --git a/src/ansys/fluent/post/matplotlib/__init__.py b/src/ansys/fluent/post/matplotlib/__init__.py deleted file mode 100644 index 4bedcf55..00000000 --- a/src/ansys/fluent/post/matplotlib/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -"""A package that provides interfacing Fluent with Matplotlib.""" - -from ansys.fluent.post.matplotlib.matplot_objects import Plots # noqa: F401 -from ansys.fluent.post.matplotlib.matplot_windows_manager import ( # noqa: F401 - matplot_windows_manager, -) diff --git a/src/ansys/fluent/post/pyvista/__init__.py b/src/ansys/fluent/post/pyvista/__init__.py deleted file mode 100644 index 242f86c8..00000000 --- a/src/ansys/fluent/post/pyvista/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -"""A package that provides interfacing Fluent with PyVista.""" - -from ansys.fluent.post.pyvista.pyvista_objects import Graphics # noqa: F401 -from ansys.fluent.post.pyvista.pyvista_windows_manager import ( # noqa: F401 - pyvista_windows_manager, -) diff --git a/src/ansys/fluent/post/__init__.py b/src/ansys/fluent/visualization/__init__.py similarity index 97% rename from src/ansys/fluent/post/__init__.py rename to src/ansys/fluent/visualization/__init__.py index e0b18150..799ab32e 100644 --- a/src/ansys/fluent/post/__init__.py +++ b/src/ansys/fluent/visualization/__init__.py @@ -89,4 +89,4 @@ def _update_vtk_version(): if import_errors: raise ImportError("\n".join(import_errors)) -from ansys.fluent.post._config import get_config, set_config # noqa: F401 +from ansys.fluent.visualization._config import get_config, set_config # noqa: F401 diff --git a/src/ansys/fluent/post/_config.py b/src/ansys/fluent/visualization/_config.py similarity index 84% rename from src/ansys/fluent/post/_config.py rename to src/ansys/fluent/visualization/_config.py index f3454468..927c72a8 100644 --- a/src/ansys/fluent/post/_config.py +++ b/src/ansys/fluent/visualization/_config.py @@ -1,10 +1,10 @@ -"""Global configuration state for post.""" +"""Global configuration state for visualization.""" _global_config = {"blocking": False, "set_view_on_display": None} def get_config() -> dict: - """Retrieve post configuration. + """Retrieve visualization configuration. Returns ------- @@ -15,7 +15,7 @@ def get_config() -> dict: def set_config(blocking: bool = False, set_view_on_display: str = None): - """Set post configuration. + """Set visualization configuration. Parameters ---------- diff --git a/src/ansys/fluent/visualization/matplotlib/__init__.py b/src/ansys/fluent/visualization/matplotlib/__init__.py new file mode 100644 index 00000000..49e3f46e --- /dev/null +++ b/src/ansys/fluent/visualization/matplotlib/__init__.py @@ -0,0 +1,6 @@ +"""A package that provides interfacing Fluent with Matplotlib.""" + +from ansys.fluent.visualization.matplotlib.matplot_objects import Plots # noqa: F401 +from ansys.fluent.visualization.matplotlib.matplot_windows_manager import ( # noqa: F401 + matplot_windows_manager, +) diff --git a/src/ansys/fluent/post/matplotlib/matplot_objects.py b/src/ansys/fluent/visualization/matplotlib/matplot_objects.py similarity index 89% rename from src/ansys/fluent/post/matplotlib/matplot_objects.py rename to src/ansys/fluent/visualization/matplotlib/matplot_objects.py index 0b269ed4..98a82c52 100644 --- a/src/ansys/fluent/post/matplotlib/matplot_objects.py +++ b/src/ansys/fluent/visualization/matplotlib/matplot_objects.py @@ -1,12 +1,14 @@ -"""Module providing post objects for Matplotlib.""" +"""Module providing visualization objects for Matplotlib.""" import inspect import sys from typing import Optional from ansys.fluent.core.meta import PyLocalContainer -from ansys.fluent.post.matplotlib.matplot_windows_manager import matplot_windows_manager -from ansys.fluent.post.post_object_defns import MonitorDefn, XYPlotDefn +from ansys.fluent.visualization.matplotlib.matplot_windows_manager import ( + matplot_windows_manager, +) +from ansys.fluent.visualization.post_object_defns import MonitorDefn, XYPlotDefn class Plots: diff --git a/src/ansys/fluent/post/matplotlib/matplot_windows_manager.py b/src/ansys/fluent/visualization/matplotlib/matplot_windows_manager.py similarity index 96% rename from src/ansys/fluent/post/matplotlib/matplot_windows_manager.py rename to src/ansys/fluent/visualization/matplotlib/matplot_windows_manager.py index e17de803..57baa773 100644 --- a/src/ansys/fluent/post/matplotlib/matplot_windows_manager.py +++ b/src/ansys/fluent/visualization/matplotlib/matplot_windows_manager.py @@ -6,11 +6,18 @@ from ansys.fluent.core.session import Session from ansys.fluent.core.utils.generic import AbstractSingletonMeta, in_notebook -from ansys.fluent.post import get_config -from ansys.fluent.post.matplotlib.plotter_defns import Plotter, ProcessPlotter -from ansys.fluent.post.post_data_extractor import XYPlotDataExtractor -from ansys.fluent.post.post_object_defns import MonitorDefn, PlotDefn, XYPlotDefn -from ansys.fluent.post.post_windows_manager import PostWindow, PostWindowsManager +from ansys.fluent.visualization import get_config +from ansys.fluent.visualization.matplotlib.plotter_defns import Plotter, ProcessPlotter +from ansys.fluent.visualization.post_data_extractor import XYPlotDataExtractor +from ansys.fluent.visualization.post_object_defns import ( + MonitorDefn, + PlotDefn, + XYPlotDefn, +) +from ansys.fluent.visualization.post_windows_manager import ( + PostWindow, + PostWindowsManager, +) class _ProcessPlotterHandle: @@ -219,7 +226,7 @@ def open_window(self, window_id: Optional[str] = None) -> str: return window_id def set_object_for_window(self, object: PlotDefn, window_id: str) -> None: - """Associate post object with running window instance. + """Associate visualization object with running window instance. Parameters ---------- diff --git a/src/ansys/fluent/post/matplotlib/plotter_defns.py b/src/ansys/fluent/visualization/matplotlib/plotter_defns.py similarity index 100% rename from src/ansys/fluent/post/matplotlib/plotter_defns.py rename to src/ansys/fluent/visualization/matplotlib/plotter_defns.py diff --git a/src/ansys/fluent/post/post_data_extractor.py b/src/ansys/fluent/visualization/post_data_extractor.py similarity index 98% rename from src/ansys/fluent/post/post_data_extractor.py rename to src/ansys/fluent/visualization/post_data_extractor.py index 891eb94d..cc38f27a 100644 --- a/src/ansys/fluent/post/post_data_extractor.py +++ b/src/ansys/fluent/visualization/post_data_extractor.py @@ -5,7 +5,7 @@ from ansys.api.fluent.v0.field_data_pb2 import PayloadTag import numpy as np -from ansys.fluent.post.post_object_defns import GraphicsDefn, PlotDefn +from ansys.fluent.visualization.post_object_defns import GraphicsDefn, PlotDefn class FieldDataExtractor: @@ -188,7 +188,7 @@ def __init__(self, post_object: PlotDefn): self._post_object: PlotDefn = post_object def fetch_data(self) -> Dict[str, Dict[str, np.array]]: - """Fetch data for post object. + """Fetch data for visualization object. Parameters ---------- diff --git a/src/ansys/fluent/post/post_object_defns.py b/src/ansys/fluent/visualization/post_object_defns.py similarity index 99% rename from src/ansys/fluent/post/post_object_defns.py rename to src/ansys/fluent/visualization/post_object_defns.py index ca4837c5..a9a8cd67 100644 --- a/src/ansys/fluent/post/post_object_defns.py +++ b/src/ansys/fluent/visualization/post_object_defns.py @@ -1,4 +1,4 @@ -"""Module providing post objects definition.""" +"""Module providing visualization objects definition.""" from abc import abstractmethod from typing import List, NamedTuple, Optional @@ -11,7 +11,7 @@ class BasePostObjectDefn: - """Base class for post objects.""" + """Base class for visualization objects.""" def _pre_display(self): local_surfaces_provider = self._get_top_most_parent()._local_surfaces_provider() diff --git a/src/ansys/fluent/post/post_windows_manager.py b/src/ansys/fluent/visualization/post_windows_manager.py similarity index 93% rename from src/ansys/fluent/post/post_windows_manager.py rename to src/ansys/fluent/visualization/post_windows_manager.py index e51ca8d6..b361bb0a 100644 --- a/src/ansys/fluent/post/post_windows_manager.py +++ b/src/ansys/fluent/visualization/post_windows_manager.py @@ -5,11 +5,11 @@ from abc import ABCMeta, abstractmethod from typing import List, Optional, Union -from ansys.fluent.post.post_object_defns import GraphicsDefn, PlotDefn +from ansys.fluent.visualization.post_object_defns import GraphicsDefn, PlotDefn class PostWindow: - """Abstract class for post window.""" + """Abstract class for visualization window.""" @abstractmethod def plot(self): @@ -18,7 +18,7 @@ def plot(self): class PostWindowsManager(metaclass=ABCMeta): - """Abstract class for post windows management.""" + """Abstract class for visualization windows management.""" @abstractmethod def open_window(self, window_id: Optional[str] = None) -> str: @@ -40,7 +40,7 @@ def open_window(self, window_id: Optional[str] = None) -> str: def set_object_for_window( self, object: Union[GraphicsDefn, PlotDefn], window_id: str ) -> None: - """Associate post object with running window instance. + """Associate visualization object with running window instance. Parameters ---------- diff --git a/src/ansys/fluent/visualization/pyvista/__init__.py b/src/ansys/fluent/visualization/pyvista/__init__.py new file mode 100644 index 00000000..25d907dd --- /dev/null +++ b/src/ansys/fluent/visualization/pyvista/__init__.py @@ -0,0 +1,6 @@ +"""A package that provides interfacing Fluent with PyVista.""" + +from ansys.fluent.visualization.pyvista.pyvista_objects import Graphics # noqa: F401 +from ansys.fluent.visualization.pyvista.pyvista_windows_manager import ( # noqa: F401 + pyvista_windows_manager, +) diff --git a/src/ansys/fluent/post/pyvista/pyvista_objects.py b/src/ansys/fluent/visualization/pyvista/pyvista_objects.py similarity index 94% rename from src/ansys/fluent/post/pyvista/pyvista_objects.py rename to src/ansys/fluent/visualization/pyvista/pyvista_objects.py index 0d82abb1..a91ee75d 100644 --- a/src/ansys/fluent/post/pyvista/pyvista_objects.py +++ b/src/ansys/fluent/visualization/pyvista/pyvista_objects.py @@ -1,4 +1,4 @@ -"""Module providing post objects for PyVista.""" +"""Module providing visualization objects for PyVista.""" import inspect import sys @@ -6,13 +6,15 @@ from ansys.fluent.core.meta import PyLocalContainer -from ansys.fluent.post.post_object_defns import ( +from ansys.fluent.visualization.post_object_defns import ( ContourDefn, MeshDefn, SurfaceDefn, VectorDefn, ) -from ansys.fluent.post.pyvista.pyvista_windows_manager import pyvista_windows_manager +from ansys.fluent.visualization.pyvista.pyvista_windows_manager import ( + pyvista_windows_manager, +) class Graphics: diff --git a/src/ansys/fluent/post/pyvista/pyvista_windows_manager.py b/src/ansys/fluent/visualization/pyvista/pyvista_windows_manager.py similarity index 98% rename from src/ansys/fluent/post/pyvista/pyvista_windows_manager.py rename to src/ansys/fluent/visualization/pyvista/pyvista_windows_manager.py index c28c0c04..85e96783 100644 --- a/src/ansys/fluent/post/pyvista/pyvista_windows_manager.py +++ b/src/ansys/fluent/visualization/pyvista/pyvista_windows_manager.py @@ -9,10 +9,13 @@ import pyvista as pv from pyvistaqt import BackgroundPlotter -from ansys.fluent.post import get_config -from ansys.fluent.post.post_data_extractor import FieldDataExtractor -from ansys.fluent.post.post_object_defns import GraphicsDefn -from ansys.fluent.post.post_windows_manager import PostWindow, PostWindowsManager +from ansys.fluent.visualization import get_config +from ansys.fluent.visualization.post_data_extractor import FieldDataExtractor +from ansys.fluent.visualization.post_object_defns import GraphicsDefn +from ansys.fluent.visualization.post_windows_manager import ( + PostWindow, + PostWindowsManager, +) class PyVistaWindow(PostWindow): @@ -395,7 +398,7 @@ def open_window(self, window_id: Optional[str] = None) -> str: return window_id def set_object_for_window(self, object: GraphicsDefn, window_id: str) -> None: - """Associate post object with running window instance. + """Associate visualization object with running window instance. Parameters ---------- diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 95d35604..7c2f2f0b 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,4 +1,4 @@ -from ansys.fluent.post import __version__ +from ansys.fluent.visualization import __version__ def test_pkg_version(): diff --git a/tests/test_post.py b/tests/test_post.py index 0e5e9da0..d6d5dcb9 100644 --- a/tests/test_post.py +++ b/tests/test_post.py @@ -6,8 +6,8 @@ import numpy as np import pytest -from ansys.fluent.post.matplotlib import Plots -from ansys.fluent.post.pyvista import Graphics +from ansys.fluent.visualization.matplotlib import Plots +from ansys.fluent.visualization.pyvista import Graphics @pytest.fixture(autouse=True)