Update title of the composites plugin of DPF (and align other names) (#…

…303) * Update title of the composites plugin of DPF * feat: common naming approach for all packages --------- Co-authored-by: Roberto Pastor Muela <[email protected]>
ansys · Jul 13, 2023 · 9a481f9 · 9a481f9
1 parent 93be7a6
commit 9a481f9
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 32 deletions.
diff --git a/README.rst b/README.rst
@@ -38,12 +38,12 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
 
 - `PyAEDT <https://aedt.docs.pyansys.com/>`_: Pythonic interface to AEDT (Ansys Electronics Desktop).
 - `PyAnsys Math <https://math.docs.pyansys.com/>`_: Pythonic interface to PyAnsys Math libraries.
-- `PyDPF-Core <https://dpf.docs.pyansys.com/>`_: Pythonic interface to Ansys DPF (Data Processing Framework) for building more advanced and customized workflows.
-- `PyDPF-Post <https://post.docs.pyansys.com/>`_: Pythonic interface to access and post process Ansys solver result files.
-- `PyDPF Composites <https://composites.dpf.docs.pyansys.com/>`_: Pythonic interface for DPF's postprocessing of layered and short-fiber composite models.
+- `PyDPF - Core <https://dpf.docs.pyansys.com/>`_: Pythonic interface to Ansys DPF (Data Processing Framework) for building more advanced and customized workflows.
+- `PyDPF - Post <https://post.docs.pyansys.com/>`_: Pythonic interface to access and post process Ansys solver result files.
+- `PyDPF - Composites <https://composites.dpf.docs.pyansys.com/>`_: Pythonic interface for DPF's postprocessing of layered and short-fiber composite models.
 - `PyFluent <https://fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent.
-- `PyFluent-Parametric <https://parametric.fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent parametric workflows.
-- `PyFluent-Visualization <https://visualization.fluent.docs.pyansys.com/>`_: Pythonic interface to visualize Ansys Fluent simulations.
+- `PyFluent - Parametric <https://parametric.fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent parametric workflows.
+- `PyFluent - Visualization <https://visualization.fluent.docs.pyansys.com/>`_: Pythonic interface to visualize Ansys Fluent simulations.
 - `PyMAPDL <https://mapdl.docs.pyansys.com/>`_: Pythonic interface to Ansys MAPDL (Mechanical APDL).
 - `PyMAPDL Reader <https://reader.docs.pyansys.com/>`_: Pythonic interface to read legacy MAPDL result files (MAPDL 14.5 and later).
 - `PyMechanical <https://mechanical.docs.pyansys.com/>`_: Pythonic interface to Ansys Mechanical.
@@ -68,9 +68,9 @@ By default, the PyAnsys metapackage installs these core modules:
 
 - `PyAEDT`_
 - `PyAnsys Math`_
-- `PyDPF-Core`_
-- `PyDPF-Post`_
-- `PyDPF Composites`_
+- `PyDPF - Core`_
+- `PyDPF - Post`_
+- `PyDPF - Composites`_
 - `PyFluent`_
 - `PyMAPDL`_
 - `PyMechanical`_
@@ -90,7 +90,7 @@ Additionally, the ``pyansys`` metapackage contains certain extra targets that
 can be installed upon request:
 
 - **mapdl-all**: This target installs the core packages and `PyMAPDL Reader`_.
-- **fluent-all**: This target installs the core packages and `PyFluent-Parametric`_ and `PyFluent-Visualization`_.
+- **fluent-all**: This target installs the core packages and `PyFluent - Parametric`_ and `PyFluent - Visualization`_.
 - **all**: This target installs all extra ``pyansys`` packages.
 
 Package installation

diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -32,19 +32,19 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF-Core
+    .. grid-item-card:: PyDPF - Core
       :img-top: _static/thumbnails/pydpf-core.png
       :link: https://dpf.docs.pyansys.com/version/stable/api/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF-Post
+    .. grid-item-card:: PyDPF - Post
       :img-top: _static/thumbnails/pydpf-post.png
       :link: https://post.docs.pyansys.com/version/stable/api/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF Composites
+    .. grid-item-card:: PyDPF - Composites
       :img-top: _static/thumbnails/pydpf-composites.png
       :link: https://composites.dpf.docs.pyansys.com/version/stable/api/index.html
       :text-align: center
@@ -56,13 +56,13 @@ PyAnsys packages API reference
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyFluent-Parametric
+    .. grid-item-card:: PyFluent - Parametric
       :img-top: _static/thumbnails/pyfluent-parametric.png
       :link: https://parametric.fluent.docs.pyansys.com/version/stable/api/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyFluent-Visualization
+    .. grid-item-card:: PyFluent - Visualization
       :img-top: _static/thumbnails/pyfluent-visualization.png
       :link: https://visualization.fluent.docs.pyansys.com/version/stable/api/index.html
       :text-align: center

diff --git a/doc/source/examples.rst b/doc/source/examples.rst
@@ -21,19 +21,19 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF-Core
+    .. grid-item-card:: PyDPF - Core
       :img-top: _static/thumbnails/pydpf-core.png
       :link: https://dpf.docs.pyansys.com/version/stable/examples/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF-Post
+    .. grid-item-card:: PyDPF - Post
       :img-top: _static/thumbnails/pydpf-post.png
       :link: https://post.docs.pyansys.com/version/stable/examples/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF Composites
+    .. grid-item-card:: PyDPF - Composites
       :img-top: _static/thumbnails/pydpf-composites.png
       :link: https://composites.dpf.docs.pyansys.com/version/stable/examples/index.html
       :text-align: center
@@ -45,13 +45,13 @@ PyAnsys packages examples
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyFluent-Parametric
+    .. grid-item-card:: PyFluent - Parametric
       :img-top: _static/thumbnails/pyfluent-parametric.png
       :link: https://parametric.fluent.docs.pyansys.com/version/stable/examples/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyFluent-Visualization
+    .. grid-item-card:: PyFluent - Visualization
       :img-top: _static/thumbnails/pyfluent-visualization.png
       :link: https://visualization.fluent.docs.pyansys.com/version/stable/examples/index.html
       :text-align: center

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -32,23 +32,23 @@ it is now a collection of many Python packages for using Ansys products through
 
       Pythonic interface to PyAnsys Math libraries
 
-    .. grid-item-card:: PyDPF-Core
+    .. grid-item-card:: PyDPF - Core
       :img-top: _static/thumbnails/pydpf-core.png
       :link: https://dpf.docs.pyansys.com/version/stable
       :text-align: center
       :class-title: pyansys-card-title
 
       Pythonic interface to DPF (Data Processing Framework) for building more advanced and customized workflows
 
-    .. grid-item-card:: PyDPF-Post
+    .. grid-item-card:: PyDPF - Post
       :img-top: _static/thumbnails/pydpf-post.png
       :link: https://post.docs.pyansys.com/version/stable
       :text-align: center
       :class-title: pyansys-card-title
 
       Pythonic interface to access and post process Ansys solver result files
 
-    .. grid-item-card:: PyDPF Composites
+    .. grid-item-card:: PyDPF - Composites
       :img-top: _static/thumbnails/pydpf-composites.png
       :link: https://composites.dpf.docs.pyansys.com/version/stable
       :text-align: center
@@ -64,15 +64,15 @@ it is now a collection of many Python packages for using Ansys products through
 
       Pythonic interface to Ansys Fluent
 
-    .. grid-item-card:: PyFluent-Parametric
+    .. grid-item-card:: PyFluent - Parametric
       :img-top: _static/thumbnails/pyfluent-parametric.png
       :link: https://parametric.fluent.docs.pyansys.com/version/stable
       :text-align: center
       :class-title: pyansys-card-title
 
       Pythonic interface to Ansys Fluent parametric workflows
 
-    .. grid-item-card:: PyFluent-Visualization
+    .. grid-item-card:: PyFluent - Visualization
       :img-top: _static/thumbnails/pyfluent-visualization.png
       :link: https://visualization.fluent.docs.pyansys.com/version/stable
       :text-align: center

diff --git a/doc/source/user_guide.rst b/doc/source/user_guide.rst
@@ -24,19 +24,19 @@ PyAnsys packages user guides
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF-Core
+    .. grid-item-card:: PyDPF - Core
       :img-top: _static/thumbnails/pydpf-core.png
       :link: https://dpf.docs.pyansys.com/version/stable/user_guide/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF-Post
+    .. grid-item-card:: PyDPF - Post
       :img-top: _static/thumbnails/pydpf-post.png
       :link: https://post.docs.pyansys.com/version/stable/user_guide/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyDPF Composites
+    .. grid-item-card:: PyDPF - Composites
       :img-top: _static/thumbnails/pydpf-composites.png
       :link: https://composites.dpf.docs.pyansys.com/version/stable/intro.html
       :text-align: center
@@ -48,13 +48,13 @@ PyAnsys packages user guides
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyFluent-Parametric
+    .. grid-item-card:: PyFluent - Parametric
       :img-top: _static/thumbnails/pyfluent-parametric.png
       :link: https://parametric.fluent.docs.pyansys.com/version/stable/users_guide/index.html
       :text-align: center
       :class-title: pyansys-card-title
 
-    .. grid-item-card:: PyFluent-Visualization
+    .. grid-item-card:: PyFluent - Visualization
       :img-top: _static/thumbnails/pyfluent-visualization.png
       :link: https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html
       :text-align: center

diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt
@@ -8,9 +8,9 @@ PyAEDT
 DPF
 PyMAPDL
 PyMAPDL Reader
-PyDPF-Core
-PyDPF-Post
-PyDPF Composites
+PyDPF - Core
+PyDPF - Post
+PyDPF - Composites
 PyDPF
 PyFluent
 PyPIM