updates on the basic tuts

luisaFelixSalles · luisaFelixSalles · commit 4de2bf105ca6 · 2024-11-12T16:07:47.000+01:00
diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst
@@ -57,9 +57,9 @@ Troubleshooting
     :hidden:
     :caption: Tutorials
 
-    tutorials/01-language_and_usage/index.rst
-    tutorials/02-processing_basics/index.rst
-    tutorials/03-post_processing_basics/index.rst
+    tutorials/01-data_structures/index.rst
+    tutorials/02-language_and_usage/index.rst
+    tutorials/03-processing_basics/index.rst
     tutorials/04-import_data/index.rst
     tutorials/05-mesh/index.rst
     tutorials/06-transform_data/index.rst
diff --git a/doc/source/user_guide/tutorials/01-data_structures/index.rst b/doc/source/user_guide/tutorials/01-data_structures/index.rst
@@ -0,0 +1,38 @@
+.. _ref_tutorials_data_structures:
+
+===================
+DPF data structures
+===================
+
+DPF uses two main data structures to handle data: Fields and Collections.
+Therefore, it is important to be aware of how the data is
+structured in those containers.
+
+The data containers can be:
+
+    - **Raw data storage structures**: Data arrays (a ``Field`` for example) or Data Maps (a ``DataTree`` for example)
+    - **Collections**: a group of same labeled objects from one DPF raw data storage structure (a ``FieldsContainer`` for example, that is a group of ``Fields`` with the same label)
+
+These tutorials explains how these structures work and how you can manipulate data within.
+
+.. grid:: 1 1 3 3
+    :gutter: 2
+    :padding: 2
+    :margin: 2
+
+    .. grid-item-card:: DPF raw data storage structures
+       :link: ref_tutorials
+       :link-type: ref
+       :text-align: center
+
+       This tutorial shows how to create and work with some DPF data arrays:
+       Field, StringField and PropertyField
+
+
+    .. grid-item-card:: DPF collections
+       :link: ref_tutorials_language_and_usage
+       :link-type: ref
+       :text-align: center
+
+       This tutorial shows how to create and work with some DPF collections:
+       FieldsContainer, MeshesContainer and ScopingContainer
diff --git a/doc/source/user_guide/tutorials/02-language_and_usage/index.rst b/doc/source/user_guide/tutorials/02-language_and_usage/index.rst
@@ -4,13 +4,9 @@
 PyDPF-Core language and usage
 =============================
 
-This tutorial gives you an overview on how the PyDPF-Core API can be used.
-Here you will learn the different ways to interact with data by calling PyDPF-Core
-commands and operators.
+This tutorials gives you an overview on how the PyDPF-Core API can be used
+to interact with data.
 
 For more detailed information on each module and function, see :ref:`ref_api_section`.
 
 
-
-
-
diff --git a/doc/source/user_guide/tutorials/02-processing_basics/index.rst b/doc/source/user_guide/tutorials/02-processing_basics/index.rst
diff --git a/doc/source/user_guide/tutorials/03-post_processing_basics/index.rst b/doc/source/user_guide/tutorials/03-post_processing_basics/index.rst
diff --git a/doc/source/user_guide/tutorials/03-processing_basics/01-main-steps.rst b/doc/source/user_guide/tutorials/03-processing_basics/01-main-steps.rst
diff --git a/doc/source/user_guide/tutorials/03-processing_basics/index.rst b/doc/source/user_guide/tutorials/03-processing_basics/index.rst
@@ -0,0 +1,42 @@
+.. _ref_tutorials_processing_basics:
+
+======================
+Processing data basics
+======================
+
+Data Processing consists in a series of operations applied to data to achieve a goal. DPF enables
+you to access and transform simulation data using customizable workflows.
+
+There is an extensive catalog of operators with different kinds and complexity that can be used together.
+We can globally categorize them in two groups:
+
+- Operators that acts directly in the data, like the mathematical, filter and averaging ones.
+- Operators that manipulate the DPF entities themselves, like the logical, sorting and components selection ones.
+
+The tutorials in this section presents some possible applications of PyDPF-Core
+
+If you are not familiarized with those concepts you can check our concepts section: :ref:`ref_concepts`
+
+.. grid:: 1 1 3 3
+    :gutter: 2
+    :padding: 2
+    :margin: 2
+
+    .. grid-item-card:: Mathematical operations
+       :link: ref_tutorials
+       :link-type: ref
+       :text-align: center
+
+       This tutorial demonstrate some mathematical operations that can be
+       performed with PyDPF-Core
+
+
+    .. grid-item-card:: Post-processing basics
+       :link: tutorials_main_steps
+       :link-type: ref
+       :text-align: center
+
+       This tutorial demonstrate a basic post-processing procedure
+       using PyDPf-Core based on its usual main steps. The goal is to
+       transform simulation data into output data that can be used to
+       visualize and analyze simulation results.
diff --git a/doc/source/user_guide/tutorials/04-import_data/index.rst b/doc/source/user_guide/tutorials/04-import_data/index.rst
@@ -20,21 +20,14 @@ From user input
        :link-type: ref
        :text-align: center
 
-       This tutorial
-
-    .. grid-item-card:: Create a data storage structure from scratch
-       :link: ref_tutorials
-       :link-type: ref
-       :text-align: center
-
-       This tutorial
+       Learn how to import data in DPF from csv file
 
-    .. grid-item-card:: Create a mesh from scratch
+    .. grid-item-card:: Represent your data in DPF
        :link: ref_tutorials
        :link-type: ref
        :text-align: center
 
-       This tutorial
+       Learn how to represent your manual input data in a DPF data storage structure
 
 From result files
 *****************
diff --git a/doc/source/user_guide/tutorials/05-mesh/index.rst b/doc/source/user_guide/tutorials/05-mesh/index.rst
@@ -4,7 +4,7 @@
 Mesh
 ====
 
-The mesh in DPF is represented by the :class:`MeshedRegion<ansys.dpf.core.meshed_region.MeshedRegion>` entity.
+The mesh in DPF is represented by the :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>` entity.
 
 These tutorials explains how to explore different attributes of a given mesh with PyDPF-Core.
 
@@ -14,6 +14,20 @@ These tutorials explains how to explore different attributes of a given mesh wit
     :padding: 2
     :margin: 2
 
+    .. grid-item-card:: Create a mesh from scratch
+       :link: ref_tutorials
+       :link-type: ref
+       :text-align: center
+
+       This tutorial
+
+    .. grid-item-card:: Get the mesh from a result file
+       :link: ref_tutorials
+       :link-type: ref
+       :text-align: center
+
+       This tutorial
+
     .. grid-item-card:: Read the mesh metadata
        :link: ref_tutorials
        :link-type: ref
diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst
@@ -24,29 +24,28 @@ of our package background so you can understand how to work with it.
     :padding: 2
     :margin: 2
 
-    .. grid-item-card:: PyDPF-Core language fundamentals
-       :link: ref_tutorials_language_and_usage
+    .. grid-item-card:: PyDPF-Core data structures
+       :link: ref_tutorials_data_structures
        :link-type: ref
        :text-align: center
 
-       Check an overview on how to use PyDPF-Core API.
-       Learn the different ways to interact with data by calling PyDPF-Core
-       classes and operators.
+       Learn the different data structures used by DPF when handling data
 
-    .. grid-item-card::  Processing data basics
-       :link: ref_tutorials_processing_basics
+    .. grid-item-card:: PyDPF-Core language
+       :link: ref_tutorials_language_and_usage
        :link-type: ref
        :text-align: center
 
-       Learn the basics on how data can be manipulated with PyDPF-Core:
-       How to create data storage structures, basic mathematics with the data...
+       Check an overview on how to use PyDPF-Core API.
+       Learn the different ways to interact with data by using PyDPF-Core
+       objects and methods.
 
-    .. grid-item-card::  Post processing simulations basics
-       :link: ref_tutorials_post_processing_basics
+    .. grid-item-card::  Processing data basics
+       :link: ref_tutorials_processing_basics
        :link-type: ref
        :text-align: center
 
-       Check a basic post-processing procedure using PyDPf-Core.
+       Learn the basics on how data can be manipulated with PyDPF-Core
 
 :fa:`book-open-reader` Features usage
 *************************************
