Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/examples_docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pydpf-post.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test_docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ PyDPF-Core plotting capabilities require `PyVista <https://pyvista.org/>`_ 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.
Expand Down
8 changes: 7 additions & 1 deletion doc/source/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,13 @@ 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]

.. 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`.

Expand Down
11 changes: 11 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@ dependencies = [
]

[project.optional-dependencies]
graphics = [
# 2D chart plotting
"matplotlib>=3.2",
# 3D plotting
"pyvista>=0.32.0",
"vtk!=9.4.0",
# Animations
"imageio < 2.28.1",
"imageio-ffmpeg",
]

plotting = [
# 2D chart plotting
"matplotlib>=3.2",
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ skip_install =
clean: True

extras =
html: plotting
html: graphics

deps =
clean:
Expand Down
Loading