From fea863c48bfd951b3675bddf6b9ce72e799ccbe1 Mon Sep 17 00:00:00 2001 From: moe-ad Date: Tue, 1 Apr 2025 10:14:32 +0200 Subject: [PATCH 1/2] chore: graphics target --- .github/workflows/examples.yml | 2 +- .github/workflows/examples_docker.yml | 2 +- .github/workflows/pydpf-post.yml | 2 +- .github/workflows/test_docker.yml | 2 +- README.md | 2 +- doc/source/getting_started/install.rst | 2 +- pyproject.toml | 2 +- tox.ini | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 43745875746..930d0fa52f0 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -101,7 +101,7 @@ jobs: - name: "Install package wheel" shell: bash run: | - pip install dist/${{ steps.wheel.outputs.wheel_name }}[plotting] + pip install dist/${{ steps.wheel.outputs.wheel_name }}[graphics] - name: "Install DPF" id: set-server-path diff --git a/.github/workflows/examples_docker.yml b/.github/workflows/examples_docker.yml index 59161839453..d15d53c42ae 100644 --- a/.github/workflows/examples_docker.yml +++ b/.github/workflows/examples_docker.yml @@ -97,7 +97,7 @@ jobs: - name: "Install package wheel" shell: bash run: | - pip install dist/${{ steps.wheel.outputs.wheel_name }}[plotting] + pip install dist/${{ steps.wheel.outputs.wheel_name }}[graphics] - name: "Install DPF" id: set-server-path diff --git a/.github/workflows/pydpf-post.yml b/.github/workflows/pydpf-post.yml index 956b800cdd9..17d81bfec11 100644 --- a/.github/workflows/pydpf-post.yml +++ b/.github/workflows/pydpf-post.yml @@ -98,7 +98,7 @@ jobs: - name: "Install ansys-dpf-core wheel" shell: bash run: | - pip install dist/${{ steps.wheel.outputs.wheel_name }}[plotting] + pip install dist/${{ steps.wheel.outputs.wheel_name }}[graphics] - name: "Install DPF" id: set-server-path diff --git a/.github/workflows/test_docker.yml b/.github/workflows/test_docker.yml index c31f03d391b..11a806adf90 100644 --- a/.github/workflows/test_docker.yml +++ b/.github/workflows/test_docker.yml @@ -79,7 +79,7 @@ jobs: - name: "Install package wheel" shell: bash run: | - pip install dist/${{ steps.wheel.outputs.wheel_name }}[plotting] + pip install dist/${{ steps.wheel.outputs.wheel_name }}[graphics] - name: "Install DPF" id: set-server-path diff --git a/README.md b/README.md index bbc50e002f3..3d1d2d84941 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ PyDPF-Core plotting capabilities require `PyVista `_ to be To install PyDPF-Core with its optional plotting functionalities, use this command: ```con - pip install ansys-dpf-core[plotting] + pip install ansys-dpf-core[graphics] ``` For more information on PyDPF-Core plotting capabilities, see [Plot](https://dpf.docs.pyansys.com/version/stable/user_guide/plotting.html) in the PyDPF-Core documentation. diff --git a/doc/source/getting_started/install.rst b/doc/source/getting_started/install.rst index 50f065b8232..6e9e1d3da5e 100644 --- a/doc/source/getting_started/install.rst +++ b/doc/source/getting_started/install.rst @@ -21,7 +21,7 @@ To install PyDPF-Core with its optional plotting functionalities, run this comma .. code:: - pip install ansys-dpf-core[plotting] + pip install ansys-dpf-core[graphics] For more information about PyDPF-Core plotting capabilities, see :ref:`user_guide_plotting`. diff --git a/pyproject.toml b/pyproject.toml index 441d8f6ba75..73931ebc49a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,7 +38,7 @@ dependencies = [ ] [project.optional-dependencies] -plotting = [ +graphics = [ # 2D chart plotting "matplotlib>=3.2", # 3D plotting diff --git a/tox.ini b/tox.ini index 791388bef5c..e5eef844f8d 100644 --- a/tox.ini +++ b/tox.ini @@ -210,7 +210,7 @@ skip_install = clean: True extras = - html: plotting + html: graphics deps = clean: From d05bd1e7aa3e0e09d635249cdcf232f69c3ab268 Mon Sep 17 00:00:00 2001 From: moe-ad Date: Thu, 3 Apr 2025 14:02:23 +0200 Subject: [PATCH 2/2] fix: review suggestions --- doc/source/getting_started/install.rst | 6 ++++++ pyproject.toml | 11 +++++++++++ 2 files changed, 17 insertions(+) diff --git a/doc/source/getting_started/install.rst b/doc/source/getting_started/install.rst index 6e9e1d3da5e..628ab2a8b73 100644 --- a/doc/source/getting_started/install.rst +++ b/doc/source/getting_started/install.rst @@ -23,6 +23,12 @@ To install PyDPF-Core with its optional plotting functionalities, run this comma pip install ansys-dpf-core[graphics] +.. warning:: + + ``pip install ansys-dpf-core[plotting]`` is equivalent to the previous command, however, the "plotting" target + only remains valid for legacy reasons and will soon be deprecated. Users are encouraged to use the "graphics" + target instead. + For more information about PyDPF-Core plotting capabilities, see :ref:`user_guide_plotting`. To use PyDPF-Core with Ansys 2022 R1, install the latest compatible version diff --git a/pyproject.toml b/pyproject.toml index 73931ebc49a..af5ddf6b9e5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -49,6 +49,17 @@ graphics = [ "imageio-ffmpeg", ] +plotting = [ + # 2D chart plotting + "matplotlib>=3.2", + # 3D plotting + "pyvista>=0.32.0", + "vtk!=9.4.0", + # Animations + "imageio < 2.28.1", + "imageio-ffmpeg", +] + [project.urls] Homepage = "https://dpf.docs.pyansys.com/" Documentation = "https://dpf.docs.pyansys.com/"