Skip to content

Commit a68bd09

Browse files
PProfiziRobPasMue
andcommitted
Update PyDPF documentation (#259)
* Update PyDPF Update PyDPF-Post and PyDPF-Core images and descriptions * Use a distinct image for PyDPF-Post * Update links.rst * Update user_guide.rst * Reorder index.rst * Update getting_started.rst * Proposal for pydpf-core.png * Proposal for pydpf-post.png * Ramdane's proposal for PyDPF-Post description * Update api.rst * Update examples.rst * Update pydpf-post.png * Update pydpf-core.png * docs: Update README.rst --------- Co-authored-by: Roberto Pastor Muela <[email protected]>
1 parent 85afde7 commit a68bd09

File tree

9 files changed

+9
-9
lines changed

9 files changed

+9
-9
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
3939
- `PyAEDT <https://aedt.docs.pyansys.com/>`_: Pythonic interface to AEDT (Ansys Electronics Desktop).
4040
- `PyAnsys Math <https://math.docs.pyansys.com/>`_: Pythonic interface to PyAnsys Math libraries.
4141
- `PyDPF-Core <https://dpf.docs.pyansys.com/>`_: Pythonic interface to Ansys DPF (Data Processing Framework) for building more advanced and customized workflows.
42-
- `PyDPF-Post <https://post.docs.pyansys.com/>`_: Pythonic interface to DPF's postprocessing toolbox for manipulating and transforming simulation data.
42+
- `PyDPF-Post <https://post.docs.pyansys.com/>`_: Pythonic interface to access and post process Ansys solver result files.
4343
- `PyDPF Composites <https://composites.dpf.docs.pyansys.com/>`_: Pythonic interface for DPF's postprocessing of layered and short-fiber composite models.
4444
- `PyFluent <https://fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent.
4545
- `PyFluent-Parametric <https://parametric.fluent.docs.pyansys.com/>`_: Pythonic interface to Ansys Fluent parametric workflows.
23.3 KB
Loading
190 KB
Loading

doc/source/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ PyAnsys packages API reference
3939
:class-title: pyansys-card-title
4040

4141
.. grid-item-card:: PyDPF-Post
42-
:img-top: _static/thumbnails/pydpf-core.png
42+
:img-top: _static/thumbnails/pydpf-post.png
4343
:link: https://post.docs.pyansys.com/version/stable/api/index.html
4444
:text-align: center
4545
:class-title: pyansys-card-title

doc/source/examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ PyAnsys packages examples
2828
:class-title: pyansys-card-title
2929

3030
.. grid-item-card:: PyDPF-Post
31-
:img-top: _static/thumbnails/pydpf-core.png
31+
:img-top: _static/thumbnails/pydpf-post.png
3232
:link: https://post.docs.pyansys.com/version/stable/examples/index.html
3333
:text-align: center
3434
:class-title: pyansys-card-title

doc/source/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Getting started
44
PyAnsys libraries fall into two categories:
55

66
- Wrappers over products like `MAPDL <https://www.ansys.com/training-center/course-catalog/structures/ansys-mechanical-advanced-use-of-mapdl-in-mechanical>`_, `Fluent <https://www.ansys.com/products/fluids/ansys-fluent>`_, or `AEDT <https://www.ansys.com/products/electronics/ansys-maxwell>`_
7-
- Supporting libraries like `DPF <dpf_core_gh>`_
7+
- Supporting libraries like `DPF <dpf_post_gh>`_
88

99
Most PyAnsys packages require a local installation of Ansys. The version
1010
of Ansys installed dictates the interface and features available to

doc/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ it is now a collection of many Python packages for using Ansys products through
4141
Pythonic interface to DPF (Data Processing Framework) for building more advanced and customized workflows
4242

4343
.. grid-item-card:: PyDPF-Post
44-
:img-top: _static/thumbnails/pydpf-core.png
44+
:img-top: _static/thumbnails/pydpf-post.png
4545
:link: https://post.docs.pyansys.com/
4646
:text-align: center
4747
:class-title: pyansys-card-title
4848

49-
Pythonic interface to DPF's postprocessing toolbox for manipulating and transforming simulation data
49+
Pythonic interface to access and post process Ansys solver result files
5050

5151
.. grid-item-card:: PyDPF Composites
5252
:img-top: _static/thumbnails/pydpf-composites.png

doc/source/links.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
.. _pyansys_support: [email protected]
44

55
.. #Other projects
6-
.. _dpf_core_gh: https://github.com/ansys/DPF-Core
7-
.. _dpf_post_gh: https://github.com/ansys/DPF-Post
6+
.. _dpf_core_gh: https://github.com/ansys/pydpf-core
7+
.. _dpf_post_gh: https://github.com/ansys/pydpf-post
88
.. _dpf_core_docs: https://dpf.docs.pyansys.com/
99
.. _dpf_post_docs: https://post.docs.pyansys.com/
1010
.. _legacy_reader_docs: https://reader.docs.pyansys.com/

doc/source/user_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ PyAnsys packages user guides
3131
:class-title: pyansys-card-title
3232

3333
.. grid-item-card:: PyDPF-Post
34-
:img-top: _static/thumbnails/pydpf-core.png
34+
:img-top: _static/thumbnails/pydpf-post.png
3535
:link: https://post.docs.pyansys.com/version/stable/user_guide/index.html
3636
:text-align: center
3737
:class-title: pyansys-card-title

0 commit comments

Comments
 (0)