Skip to content

Commit 51fc7b9

Browse files
updates on the index pages
1 parent db55259 commit 51fc7b9

File tree

12 files changed

+46
-12
lines changed

12 files changed

+46
-12
lines changed

doc/source/user_guide/tutorials/01-language_and_usage/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
PyDPF-Core language and usage
55
=============================
66

7-
This tutorial gives you an overview on how the the PyDPF-COre API can be used.
7+
This tutorial gives you an overview on how the PyDPF-Core API can be used.
88
Here you will learn the different ways to interact with data by calling PyDPF-Core
99
commands and operators.
1010

doc/source/user_guide/tutorials/04-import_data/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ From user input
3939
From result files
4040
*****************
4141

42-
.. grid:: 2
42+
.. grid:: 1 1 3 3
4343
:gutter: 2
4444
:padding: 2
4545
:margin: 2

doc/source/user_guide/tutorials/05-mesh/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
Mesh
55
====
66

7+
The mesh in DPF is represented by the :class:`MeshedRegion<ansys.dpf.core.meshed_region.MeshedRegion>` entity.
8+
9+
These tutorials explains how to explore different attributes of a given mesh with PyDPF-Core.
10+
11+
712
.. grid:: 1 1 3 3
813
:gutter: 2
914
:padding: 2

doc/source/user_guide/tutorials/06-transform_data/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@
44
Transform data
55
==============
66

7+
An operator is the main object that is used to create, transform, and stream data in DPF.
8+
9+
They can perform different modifications with the data: direct mathematical operations,
10+
averaging in the mesh, changes in the model locations .... They can also be chained together
11+
to create more complex operations and customizable results.
12+
13+
The tutorials in this section aims to explain how to transform and operate on data to obtain
14+
the desired input by using the DPF operators with PyDPF-Core.
15+
16+
For more information on how to program with PyDPF-Core check the
17+
:ref:`ref_tutorials_language_and_usage` tutorial.
18+
19+
720
.. grid:: 1 1 3 3
821
:gutter: 2
922
:padding: 2

doc/source/user_guide/tutorials/07-export_data/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@
44
Export data
55
===========
66

7+
Data in DPF can be exported to universal file formats, such as VTK, HDF5, and TXT files.
8+
You can use it to generate TH-plots, screenshots, and animations or to create custom result
9+
plots using the `numpy <https://numpy.org/>`_ and `matplotlib <https://matplotlib.org/>`_ packages.
10+
11+
These tutorials explains how to export data from your manipulations with PyDPF-Core.
12+
713
.. grid:: 1 1 3 3
814
:gutter: 2
915
:padding: 2
1016
:margin: 2
1117

12-
.. grid-item-card:: Export to XXX
18+
.. grid-item-card:: HDF5 export
1319
:link: ref_tutorials
1420
:link-type: ref
1521
:text-align: center

doc/source/user_guide/tutorials/08-plot/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Plot
55
====
66

7+
These tutorials demonstrate some different approaches to visualise the data in plots.
8+
79
.. grid:: 1 1 3 3
810
:gutter: 2
911
:padding: 2

doc/source/user_guide/tutorials/09-animate/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Animate
55
=======
66

7+
These tutorials demonstrate how to visualise the data in an animation.
8+
79
.. grid:: 1 1 3 3
810
:gutter: 2
911
:padding: 2

doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Enriching DPF capabilities
55
==========================
66

7+
The available DPF capabilities loaded in a DPF application can be enhanced
8+
by creating new operator’s libraries. DPF offers multiple development APIs
9+
depending on your environment.
10+
11+
These tutorials demonstrate how to develop those plugins for PyDPF-Core (CPython based)
12+
713
.. grid:: 1 1 3 3
814
:gutter: 2
915
:padding: 2
@@ -16,13 +22,6 @@ Enriching DPF capabilities
1622

1723
This tutorial
1824

19-
.. grid-item-card:: Configure DPF plugins load
20-
:link: ref_tutorials
21-
:link-type: ref
22-
:text-align: center
23-
24-
This tutorial
25-
2625
.. grid-item-card:: Create a plug-in package with multiple operators
2726
:link: ref_tutorials
2827
:link-type: ref

doc/source/user_guide/tutorials/11-distributed_files/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Post-process distributed files
55
==============================
66

7+
These tutorials show how to create workflows on different processes (possibly on different machines) and connect them.
8+
79
.. grid:: 1 1 3 3
810
:gutter: 2
911
:padding: 2

doc/source/user_guide/tutorials/12-dpf_server/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
DPF server
55
==========
66

7+
This tutorial explains how to manipulate DPF client-server architecture
8+
79
.. grid:: 1 1 3 3
810
:gutter: 2
911
:padding: 2

0 commit comments

Comments
 (0)