Skip to content

Commit 4a2e9d3

Browse files
luisaFelixSallesluisaFelixSalles
committed
layout changes
1 parent 3421141 commit 4a2e9d3

File tree

16 files changed

+137
-45
lines changed

16 files changed

+137
-45
lines changed

‎doc/source/user_guide/index.rst‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,19 @@ Troubleshooting
5757
:hidden:
5858
:caption: Tutorials
5959

60-
tutorials/basic_tutorial_index.rst
61-
tutorials/02-import_data/index.rst
62-
tutorials/03-mesh/index.rst
63-
tutorials/04-transform_data/index.rst
64-
tutorials/05-plot/index.rst
65-
tutorials/06-animate/index.rst
60+
tutorials/01-language_and_usage/index.rst
61+
tutorials/02-processing_basics/index.rst
62+
tutorials/03-post_processing_basics/index.rst
63+
tutorials/04-import_data/index.rst
64+
tutorials/05-mesh/index.rst
65+
tutorials/06-transform_data/index.rst
6666
tutorials/07-export_data/index.rst
67-
tutorials/08-enriching_dpf_capabilities/index.rst
68-
tutorials/09-distributed_files/index.rst
69-
tutorials/10-dpf_server/index.rst
70-
tutorials/11-licensing/index.rst
67+
tutorials/08-plot/index.rst
68+
tutorials/09-animate/index.rst
69+
tutorials/10-enriching_dpf_capabilities/index.rst
70+
tutorials/11-distributed_files/index.rst
71+
tutorials/12-dpf_server/index.rst
72+
tutorials/13-licensing/index.rst
7173

7274
.. toctree::
7375
:maxdepth: 2

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _ref_tutorials_language_and_usage:
2+
3+
=============================
4+
PyDPF-Core language and usage
5+
=============================
6+
7+
This tutorial gives you an overview on how the the PyDPF-COre API can be used.
8+
For more detailed information on each module and function, see :ref:`api_section`.
9+
10+
11+
12+
13+

‎doc/source/user_guide/tutorials/02-processing_basics/index.rst‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. _ref_tutorials_processing_basics:
2+
3+
======================
4+
Processing data basics
5+
======================
6+
7+
When DPF employ operators to manipulate the data,it uses data containers
8+
to store and return it. Therefore, it is important to be aware of how the
9+
data is structured in those containers.
10+
11+
The data containers can be:
12+
13+
- **Raw data storage structures**: Data arrays (a ``Field`` for example)
14+
or Data Maps (a ``DataTree`` for example)
15+
- **Collections**: a group of same labeled objects from one DPF raw data
16+
storage structure (a ``FieldsContainer`` for example, that is a group of ``Fields``
17+
with the same label)
18+
19+
The tutorials in this section presents the basics on how to create and manipulate data
20+
with those structures.
21+
22+
If you are not familiarized with those concepts you can check our concepts section: :ref:`ref_concepts`
23+
24+
.. grid:: 1 1 3 3
25+
:gutter: 2
26+
:padding: 2
27+
:margin: 2
28+
29+
.. grid-item-card:: Creating DPF raw data storage structures
30+
:link: ref_tutorials
31+
:link-type: ref
32+
:text-align: center
33+
34+
This tutorial shows how to create and work with some DPF data arrays:
35+
Field, StringField and PropertyField
36+
37+
.. grid-item-card:: Creating DPF collections
38+
:link: ref_tutorials
39+
:link-type: ref
40+
:text-align: center
41+
42+
This tutorial shows how to create and work with some DPF collections:
43+
FieldsContainer, MeshesContainer, ScopingsContainer
44+
45+
.. grid-item-card:: Mathematical operations
46+
:link: ref_tutorials
47+
:link-type: ref
48+
:text-align: center
49+
50+
This tutorial demonstrate some mathematical operations that can be
51+
performed with PyDPF-Core

‎doc/source/user_guide/tutorials/01-main-steps.rst‎ renamed to ‎doc/source/user_guide/tutorials/03-post_processing_basics/01-main-steps.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ be used to visualize and analyze simulation results:
4444
:link-type: ref
4545
:text-align: center
4646

47-
Extract data
47+
Export data
4848

4949
.. _tutorials_main_steps_1:
5050

‎doc/source/user_guide/tutorials/03-post_processing_basics/index.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _ref_tutorials_post_processing_basics:
2+
3+
======================
4+
Post processing basics
5+
======================
6+
7+
This tutorial demonstrate a basic post-processing procedure
8+
using PyDPf-Core based on its usual main steps.
9+
10+
When post-processing with PyDPf-Core, the goal is to transform simulation data
11+
into output data that can be used to visualize and analyze simulation results.
12+
13+
.. include:: 01-main-steps.rst
14+
15+

‎doc/source/user_guide/tutorials/02-import_data/index.rst‎ renamed to ‎doc/source/user_guide/tutorials/04-import_data/index.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. _ref_tutorials_others_import_data:
1+
.. _ref_tutorials_import_data:
22

3+
===========
34
Import Data
4-
-----------
5+
===========
56

67
From user input
78
***************

‎doc/source/user_guide/tutorials/03-mesh/index.rst‎ renamed to ‎doc/source/user_guide/tutorials/05-mesh/index.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. _ref_tutorials_others_mesh:
1+
.. _ref_tutorials_mesh:
22

3+
====
34
Mesh
4-
----
5+
====
56

67
.. grid:: 2
78
:gutter: 2

‎doc/source/user_guide/tutorials/04-transform_data/index.rst‎ renamed to ‎doc/source/user_guide/tutorials/06-transform_data/index.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. _ref_tutorials_others_transform_data:
1+
.. _ref_tutorials_transform_data:
22

3+
==============
34
Transform data
4-
--------------
5+
==============
56

67
.. grid:: 2
78
:gutter: 2

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. _ref_tutorials_others_export_data:
1+
.. _ref_tutorials_export_data:
22

3+
===========
34
Export data
4-
-----------
5+
===========
56

67
.. grid:: 2
78
:gutter: 2

‎doc/source/user_guide/tutorials/05-plot/index.rst‎ renamed to ‎doc/source/user_guide/tutorials/08-plot/index.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. _ref_tutorials_others_plot:
1+
.. _ref_tutorials_plot:
22

3+
====
34
Plot
4-
----
5+
====
56

67
.. grid:: 2
78
:gutter: 2

0 commit comments

Comments
 (0)