From b6a4928889f9f639e4862c68e0e8d653ad98cca7 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Mon, 21 Oct 2024 17:38:24 +0200 Subject: [PATCH 01/23] new tutorials layout --- doc/source/user_guide/index.rst | 3 +++ doc/source/user_guide/tutorials/index.rst | 26 +++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 doc/source/user_guide/tutorials/index.rst diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 7d1dfab4ae..38deec0f8b 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -16,6 +16,9 @@ The goals of this section are to: .. include:: concepts/index.rst +.. include:: + tutorials/index.rst + .. include:: main_entities.rst diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst new file mode 100644 index 0000000000..461e309667 --- /dev/null +++ b/doc/source/user_guide/tutorials/index.rst @@ -0,0 +1,26 @@ +.. _ref_tutorials: + +Tutorials +--------- + +The tutorials go through the steps required to access, analyze, +and transform simulation data using PyDPF-Core. + +Tutorials are more substantive and complex than examples. They are designed to teach how to perform a task and understand +the underlying concepts, providing detailed explanations at each stage, whereas examples showcase end-to-end specific processes. + +.. grid:: 1 1 2 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Beginners guide + :link: user_guide_concepts + :link-type: ref + :text-align: center + + + .. grid-item-card:: Fundamentals and usage + :link: user_guide_waysofusing + :link-type: ref + :text-align: center From bc998a3f714ecc9c81cdb2e943ece5595b1fa5a9 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 22 Oct 2024 12:10:12 +0200 Subject: [PATCH 02/23] user guide index page with tutorials --- doc/source/user_guide/tutorials/index.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 461e309667..fb406a7c47 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -14,13 +14,18 @@ the underlying concepts, providing detailed explanations at each stage, whereas :padding: 2 :margin: 2 - .. grid-item-card:: Beginners guide + .. grid-item-card:: :fa:`person-running` Onboarding :link: user_guide_concepts :link-type: ref :text-align: center + New to PyDPF-Core? Check our beginner's tutorial. It offers an overview + of our basic key features and links to additional tutorials. - .. grid-item-card:: Fundamentals and usage + .. grid-item-card:: :fa:`book-open-reader` Fundamentals and usage :link: user_guide_waysofusing :link-type: ref :text-align: center + + These tutorials provides detailed demonstrations on PyDPF-Core key features. + From bd08a1e22b7f2fdd2a1778cdc62b3b0aeef618ff Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 22 Oct 2024 15:18:27 +0200 Subject: [PATCH 03/23] add new basic tutorial and jupyter_ sphinx extension --- doc/source/conf.py | 1 + .../user_guide/tutorials/basic_tutorial.rst | 241 ++++++++++++++++++ doc/source/user_guide/tutorials/index.rst | 2 +- requirements/requirements_docs.txt | 1 + 4 files changed, 244 insertions(+), 1 deletion(-) create mode 100644 doc/source/user_guide/tutorials/basic_tutorial.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 571e9f8bff..b80e9b25f7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -87,6 +87,7 @@ "sphinx_design", "sphinx_gallery.gen_gallery", 'sphinx_reredirects', + "jupyter_sphinx", ] redirects = { diff --git a/doc/source/user_guide/tutorials/basic_tutorial.rst b/doc/source/user_guide/tutorials/basic_tutorial.rst new file mode 100644 index 0000000000..11b7097676 --- /dev/null +++ b/doc/source/user_guide/tutorials/basic_tutorial.rst @@ -0,0 +1,241 @@ +.. _ref_tutorials_basic: + +================== +The basic tutorial +================== + +This tutorial guides throughout the basic concepts and features of the PyDPF-Core tool. +It helps to have a Python interpreter for hands-on experience, but all code examples are +executed, so the tutorial can be read off-line as well. + +For a complete description of all the objects and modules, see the :ref:`API reference ` section. + +This page is divided in two sections: + +.. grid:: 1 1 2 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Overview + :link: tutorials_overview + :link-type: ref + :text-align: center + + Learn the different ways to interact with data by calling PyDPF-Core commands and operators. + + .. grid-item-card:: Postprocessing main steps + :link: tutorials_main_steps + :link-type: ref + :text-align: center + + How to do a basic prost-processing by transforming simulation data into output + data that can be used to visualize and analyze results + +.. _tutorials_overview: + +Overview +-------- + + + +.. _tutorials_main_steps: + +Postprocessing main steps +------------------------- + +There are five main steps to transform simulation data into output data that can +be used to visualize and analyze simulation results: + +.. grid:: + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: 1 + :link: tutorials_main_steps_1 + :link-type: ref + :text-align: center + + Importing and opening results files + + .. grid-item-card:: 2 + :link: tutorials_main_steps_2 + :link-type: ref + :text-align: center + + Access and extract results + + .. grid-item-card:: 3 + :link: tutorials_main_steps_3 + :link-type: ref + :text-align: center + + Transform available data + + .. grid-item-card:: 4 + :link: tutorials_main_steps_4 + :link-type: ref + :text-align: center + + Visualize the data + + .. grid-item-card:: 5 + :link: tutorials_main_steps_5 + :link-type: ref + :text-align: center + + Extract data + +.. _tutorials_main_steps_1: + +1- Importing and opening results files +************************************** + +First, import the DPF-Core module as ``dpf`` and import the included examples file + +.. code-block:: python + + from ansys.dpf import core as dpf + from ansys.dpf.core import examples + from ansys.dpf.core import operators as ops + +`DataSources' is a class that manages paths to their files. Use this object to declare +data inputs for DPF and define their locations. + +.. code-block:: python + + # Define the DataSources object + my_data_sources = dpf.DataSources(result_path=examples.find_simple_bar()) + + +The model is a helper designed to give shortcuts to access the analysis results +metadata, by opening a DataSources or a Streams, and to instanciate results provider for it. + +Printing the model displays: + + - Analysis type + - Available results + - Size of the mesh + - Number of results + +.. code-block:: python + + # Define the Model object + my_model = dpf.Model(data_sources=my_data_sources) + print(my_model) + +.. rst-class:: sphx-glr-script-out + + .. jupyter-execute:: + :hide-code: + + from ansys.dpf import core as dpf + from ansys.dpf.core import examples + from ansys.dpf.core import operators as ops + my_data_sources = dpf.DataSources(result_path=examples.find_simple_bar()) + my_model = dpf.Model(data_sources=my_data_sources) + print(my_model) + +.. _tutorials_main_steps_2: + +2- Access and extract results +***************************** + +We see in the model that a displacement result is available. You can access this result by: + +.. code-block:: python + + # Define the displacement results through the models property `results` + my_displacements = my_model.results.displacement.eval() + print(my_displacements) + +.. rst-class:: sphx-glr-script-out + + .. jupyter-execute:: + :hide-code: + + my_displacements = my_model.results.displacement.eval() + print(my_displacements) + +The displacement data can be extract by: + +.. code-block:: python + + # Extract the data of the displacement field + my_displacements_0 = my_displacements[0].data + print(my_displacements_0) + +.. rst-class:: sphx-glr-script-out + + .. jupyter-execute:: + :hide-code: + + my_displacements_0 = my_displacements[0].data + print(my_displacements_0) + +.. _tutorials_main_steps_3: + +3- Transform available data +*************************** + +Several transformations can be made with the data. They can be a single operation, +by using only one operator, or they can represent a succession of operations, by defining a +workflow with chained operators. + +Here we star by computing the displacements norm. + +.. code-block:: python + + # Define the norm operator (here for a fields container) for the displacement + my_norm = ops.math.norm_fc(fields_container=my_displacements).eval() + print(my_norm[0].data) + +.. rst-class:: sphx-glr-script-out + + .. jupyter-execute:: + :hide-code: + + my_norm = ops.math.norm_fc(fields_container=my_displacements).eval() + print(my_norm[0].data) + +Then we compute the maximum values of the normalised displacement + +.. code-block:: python + + # Define the maximum operator and chain it to the norm operator + my_max= ops.min_max.min_max_fc(fields_container=my_norm).outputs.field_max() + print(my_max) + +.. rst-class:: sphx-glr-script-out + + .. jupyter-execute:: + :hide-code: + + my_max = ops.min_max.min_max_fc(fields_container=my_norm).outputs.field_max() + print(my_max) + +.. _tutorials_main_steps_4: + +4- Visualize the data +********************* + +Plot the transformed displacement results + +.. code-block:: python + + # Define the support of the plot (here we plot the displacement over the mesh) + my_model.metadata.meshed_region.plot(field_or_fields_container=my_displacements) + +.. rst-class:: sphx-glr-script-out + + .. jupyter-execute:: + :hide-code: + + my_model.metadata.meshed_region.plot(field_or_fields_container=my_displacements) + +.. _tutorials_main_steps_5: + +5- Extract the data +******************* + diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index fb406a7c47..ed4f9acfe3 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -15,7 +15,7 @@ the underlying concepts, providing detailed explanations at each stage, whereas :margin: 2 .. grid-item-card:: :fa:`person-running` Onboarding - :link: user_guide_concepts + :link: ref_tutorials_basic :link-type: ref :text-align: center diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt index 594ce0a0d6..7552113784 100644 --- a/requirements/requirements_docs.txt +++ b/requirements/requirements_docs.txt @@ -3,6 +3,7 @@ enum-tools[sphinx]==0.12.0 graphviz==0.20.1 imageio==2.36.0 imageio-ffmpeg==0.5.1 +jupyter_sphinx==0.5.3, nbsphinx==0.9.5 pypandoc==1.14 pytest-sphinx==0.6.3 From 64b4a63903d6804e0673c99426509ea1913a0687 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 22 Oct 2024 15:20:35 +0200 Subject: [PATCH 04/23] add new basic tutorial in the sidebar --- doc/source/user_guide/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 38deec0f8b..422644b6ad 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -64,6 +64,12 @@ Troubleshooting concepts/waysofusing.rst concepts/stepbystep.rst +.. toctree:: + :maxdepth: 2 + :hidden: + :caption: Tutorials + + tutorials/basic_tutorial.rst .. toctree:: :maxdepth: 2 From 992c045508a9225e78591770fc2085be5086cb13 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 22 Oct 2024 16:16:10 +0200 Subject: [PATCH 05/23] add new fundamentals tutorial page --- doc/source/user_guide/index.rst | 1 + doc/source/user_guide/tutorials/index.rst | 3 +- .../user_guide/tutorials/other_tutorials.rst | 97 +++++++++++++++++++ 3 files changed, 99 insertions(+), 2 deletions(-) create mode 100644 doc/source/user_guide/tutorials/other_tutorials.rst diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 422644b6ad..f1f975ab78 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -70,6 +70,7 @@ Troubleshooting :caption: Tutorials tutorials/basic_tutorial.rst + tutorials/other_tutorials.rst .. toctree:: :maxdepth: 2 diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index ed4f9acfe3..d5b69a9b47 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -23,9 +23,8 @@ the underlying concepts, providing detailed explanations at each stage, whereas of our basic key features and links to additional tutorials. .. grid-item-card:: :fa:`book-open-reader` Fundamentals and usage - :link: user_guide_waysofusing + :link: ref_tutorials_others :link-type: ref :text-align: center These tutorials provides detailed demonstrations on PyDPF-Core key features. - diff --git a/doc/source/user_guide/tutorials/other_tutorials.rst b/doc/source/user_guide/tutorials/other_tutorials.rst new file mode 100644 index 0000000000..d4a5847d32 --- /dev/null +++ b/doc/source/user_guide/tutorials/other_tutorials.rst @@ -0,0 +1,97 @@ +.. _ref_tutorials_others: + +Fundamentals and usage +---------------------- + +These tutorials cover specifics features with detailed demonstrations to help +understanding the fundamental PyDPF-Core functionalities and clarify some concepts. + +They are categorised based on PyDPF-Core usage : + +.. grid:: 4 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Results + :link: tutorials_other_feature_1 + :link-type: ref + :text-align: center + + .. grid-item-card:: Mesh + :link: tutorials_other_feature_2 + :link-type: ref + :text-align: center + + .. grid-item-card:: Transform data + :link: tutorials_other_feature_3 + :link-type: ref + :text-align: center + + .. grid-item-card:: Plot + :link: tutorials_other_feature_4 + :link-type: ref + :text-align: center + + .. grid-item-card:: Animate + :link: tutorials_other_feature_5 + :link-type: ref + :text-align: center + + .. grid-item-card:: Export data + :link: tutorials_other_feature_6 + :link-type: ref + :text-align: center + + .. grid-item-card:: Enriching DPF capabilities + :link: tutorials_other_feature_7 + :link-type: ref + :text-align: center + + .. grid-item-card:: Post-process distributed files + :link: tutorials_other_feature_8 + :link-type: ref + :text-align: center + +.. _tutorials_other_feature_1: + +Results +------- + + + +.. _tutorials_other_feature_2: + +Mesh +---- + +.. _tutorials_other_feature_3: + +Transform data +-------------- + +.. _tutorials_other_feature_4: + +Plot +---- + +.. _tutorials_other_feature_5: + +Animate +------- + +.. _tutorials_other_feature_6: + +Export data +----------- + +.. _tutorials_other_feature_7: + +Enriching DPF capabilities +-------------------------- + +.. _tutorials_other_feature_8: + +Post-process distributed files +------------------------------ + From a0d288e48cd07d54ecae59208f50e0d9d7fe687d Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 22 Oct 2024 16:20:29 +0200 Subject: [PATCH 06/23] reorganizing --- doc/source/user_guide/index.rst | 4 +- .../user_guide/tutorials/00-overview.rst | 5 +++ .../{basic_tutorial.rst => 01-main-steps.rst} | 44 +------------------ .../tutorials/basic_tutorial_index.rst | 40 +++++++++++++++++ ...utorials.rst => other_tutorials_index.rst} | 0 5 files changed, 48 insertions(+), 45 deletions(-) create mode 100644 doc/source/user_guide/tutorials/00-overview.rst rename doc/source/user_guide/tutorials/{basic_tutorial.rst => 01-main-steps.rst} (81%) create mode 100644 doc/source/user_guide/tutorials/basic_tutorial_index.rst rename doc/source/user_guide/tutorials/{other_tutorials.rst => other_tutorials_index.rst} (100%) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index f1f975ab78..87c6cabb66 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -69,8 +69,8 @@ Troubleshooting :hidden: :caption: Tutorials - tutorials/basic_tutorial.rst - tutorials/other_tutorials.rst + tutorials/basic_tutorial_index.rst + tutorials/other_tutorials_index.rst .. toctree:: :maxdepth: 2 diff --git a/doc/source/user_guide/tutorials/00-overview.rst b/doc/source/user_guide/tutorials/00-overview.rst new file mode 100644 index 0000000000..826cc9bea1 --- /dev/null +++ b/doc/source/user_guide/tutorials/00-overview.rst @@ -0,0 +1,5 @@ +.. _tutorials_overview: + +Overview +-------- + diff --git a/doc/source/user_guide/tutorials/basic_tutorial.rst b/doc/source/user_guide/tutorials/01-main-steps.rst similarity index 81% rename from doc/source/user_guide/tutorials/basic_tutorial.rst rename to doc/source/user_guide/tutorials/01-main-steps.rst index 11b7097676..67a2d5dec4 100644 --- a/doc/source/user_guide/tutorials/basic_tutorial.rst +++ b/doc/source/user_guide/tutorials/01-main-steps.rst @@ -1,44 +1,3 @@ -.. _ref_tutorials_basic: - -================== -The basic tutorial -================== - -This tutorial guides throughout the basic concepts and features of the PyDPF-Core tool. -It helps to have a Python interpreter for hands-on experience, but all code examples are -executed, so the tutorial can be read off-line as well. - -For a complete description of all the objects and modules, see the :ref:`API reference ` section. - -This page is divided in two sections: - -.. grid:: 1 1 2 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Overview - :link: tutorials_overview - :link-type: ref - :text-align: center - - Learn the different ways to interact with data by calling PyDPF-Core commands and operators. - - .. grid-item-card:: Postprocessing main steps - :link: tutorials_main_steps - :link-type: ref - :text-align: center - - How to do a basic prost-processing by transforming simulation data into output - data that can be used to visualize and analyze results - -.. _tutorials_overview: - -Overview --------- - - - .. _tutorials_main_steps: Postprocessing main steps @@ -237,5 +196,4 @@ Plot the transformed displacement results .. _tutorials_main_steps_5: 5- Extract the data -******************* - +******************* \ No newline at end of file diff --git a/doc/source/user_guide/tutorials/basic_tutorial_index.rst b/doc/source/user_guide/tutorials/basic_tutorial_index.rst new file mode 100644 index 0000000000..140f733479 --- /dev/null +++ b/doc/source/user_guide/tutorials/basic_tutorial_index.rst @@ -0,0 +1,40 @@ +.. _ref_tutorials_basic: + +================== +The basic tutorial +================== + +This tutorial guides throughout the basic concepts and features of the PyDPF-Core tool. +It helps to have a Python interpreter for hands-on experience, but all code examples are +executed, so the tutorial can be read off-line as well. + +For a complete description of all the objects and modules, see the :ref:`API reference ` section. + +This page is divided in two sections: + +.. grid:: 1 1 2 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Overview + :link: tutorials_overview + :link-type: ref + :text-align: center + + Learn the different ways to interact with data by calling PyDPF-Core commands and operators. + + .. grid-item-card:: Postprocessing main steps + :link: tutorials_main_steps + :link-type: ref + :text-align: center + + How to do a basic prost-processing by transforming simulation data into output + data that can be used to visualize and analyze results + +.. include:: + 00-overview.rst + +.. include:: + 01-main-steps.rst + diff --git a/doc/source/user_guide/tutorials/other_tutorials.rst b/doc/source/user_guide/tutorials/other_tutorials_index.rst similarity index 100% rename from doc/source/user_guide/tutorials/other_tutorials.rst rename to doc/source/user_guide/tutorials/other_tutorials_index.rst From f616dd1785519eb2a4f5184d755f24ee9d2558e0 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Wed, 23 Oct 2024 10:53:44 +0200 Subject: [PATCH 07/23] add fundamentals and usage tutorials and their sections --- .../tutorials/other_tutorials_index.rst | 220 +++++++++++++++--- 1 file changed, 188 insertions(+), 32 deletions(-) diff --git a/doc/source/user_guide/tutorials/other_tutorials_index.rst b/doc/source/user_guide/tutorials/other_tutorials_index.rst index d4a5847d32..bf4185f428 100644 --- a/doc/source/user_guide/tutorials/other_tutorials_index.rst +++ b/doc/source/user_guide/tutorials/other_tutorials_index.rst @@ -1,97 +1,253 @@ .. _ref_tutorials_others: +====================== Fundamentals and usage ----------------------- +====================== These tutorials cover specifics features with detailed demonstrations to help understanding the fundamental PyDPF-Core functionalities and clarify some concepts. They are categorised based on PyDPF-Core usage : -.. grid:: 4 +Import Data +----------- + +From user input +*************** + +.. grid:: 2 :gutter: 2 :padding: 2 :margin: 2 - .. grid-item-card:: Results - :link: tutorials_other_feature_1 + .. grid-item-card:: Import data from csv file + :link: ref_tutorials :link-type: ref :text-align: center - .. grid-item-card:: Mesh - :link: tutorials_other_feature_2 - :link-type: ref - :text-align: center + This tutorial - .. grid-item-card:: Transform data - :link: tutorials_other_feature_3 + .. grid-item-card:: Create a data storage structure from scratch + :link: ref_tutorials :link-type: ref :text-align: center - .. grid-item-card:: Plot - :link: tutorials_other_feature_4 + This tutorial + + .. grid-item-card:: Create a mesh from scratch + :link: ref_tutorials :link-type: ref :text-align: center - .. grid-item-card:: Animate - :link: tutorials_other_feature_5 + This tutorial + +From result files +***************** + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Extract and explore results metadata + :link: ref_tutorials :link-type: ref :text-align: center - .. grid-item-card:: Export data - :link: tutorials_other_feature_6 + This tutorial + + .. grid-item-card:: Extract and explore results + :link: ref_tutorials :link-type: ref :text-align: center - .. grid-item-card:: Enriching DPF capabilities - :link: tutorials_other_feature_7 + This tutorial + + .. grid-item-card:: Narrow down data (scoping tutorial) + :link: ref_tutorials :link-type: ref :text-align: center - .. grid-item-card:: Post-process distributed files - :link: tutorials_other_feature_8 + This tutorial + +Mesh +---- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Read the mesh metadata + :link: ref_tutorials :link-type: ref :text-align: center -.. _tutorials_other_feature_1: + This tutorial -Results -------- + .. grid-item-card:: Read the mesh + :link: ref_tutorials + :link-type: ref + :text-align: center + This tutorial + .. grid-item-card:: Read a subpart of the mesh + :link: ref_tutorials + :link-type: ref + :text-align: center -.. _tutorials_other_feature_2: + This tutorial -Mesh ----- + .. grid-item-card:: Split the mesh + :link: ref_tutorials + :link-type: ref + :text-align: center -.. _tutorials_other_feature_3: + This tutorial Transform data -------------- -.. _tutorials_other_feature_4: +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Using operators + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Create a workflow + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + Plot ---- -.. _tutorials_other_feature_5: +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Plotting meshes + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Plotting 3D data + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Plotting 2D data + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + Animate ------- -.. _tutorials_other_feature_6: +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Animate transient data + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Animate modal data + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial Export data ----------- -.. _tutorials_other_feature_7: +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Export to XXX + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + Enriching DPF capabilities -------------------------- -.. _tutorials_other_feature_8: +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Create custom operators and plugins + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Configure DPF plugins load + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial Post-process distributed files ------------------------------ +DPF server +---------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Switch between local and remote server + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +Licensing +--------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Access Entry and Premium Capabilities + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial \ No newline at end of file From 7c79417ea9092d57aaaff36cb61fd153469c3ace Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 7 Nov 2024 11:31:42 +0100 Subject: [PATCH 08/23] add more required tutorials --- .../tutorials/other_tutorials_index.rst | 53 +++++++++++++++---- 1 file changed, 43 insertions(+), 10 deletions(-) diff --git a/doc/source/user_guide/tutorials/other_tutorials_index.rst b/doc/source/user_guide/tutorials/other_tutorials_index.rst index bf4185f428..af77b56637 100644 --- a/doc/source/user_guide/tutorials/other_tutorials_index.rst +++ b/doc/source/user_guide/tutorials/other_tutorials_index.rst @@ -128,6 +128,12 @@ Transform data This tutorial + .. grid-item-card:: Mathematical operations with PyDPF-Core data storage structures + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial Plot ---- @@ -144,20 +150,26 @@ Plot This tutorial - .. grid-item-card:: Plotting 3D data + .. grid-item-card:: Plotting data on the mesh :link: ref_tutorials :link-type: ref :text-align: center This tutorial - .. grid-item-card:: Plotting 2D data + .. grid-item-card:: Plotting data on specific placements :link: ref_tutorials :link-type: ref :text-align: center This tutorial + .. grid-item-card:: Plotting a graph + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial Animate ------- @@ -167,14 +179,7 @@ Animate :padding: 2 :margin: 2 - .. grid-item-card:: Animate transient data - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Animate modal data + .. grid-item-card:: Animate data :link: ref_tutorials :link-type: ref :text-align: center @@ -219,9 +224,37 @@ Enriching DPF capabilities This tutorial + .. grid-item-card:: Create a plug-in package with multiple operators + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Create a plug-in package that has third-party dependencies + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + Post-process distributed files ------------------------------ + .. grid-item-card:: Post process data on distributed processes + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Create a custom workflow on distributed processes + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + DPF server ---------- From 0046af2eb9942468ab94f5501297888c3d24b248 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 7 Nov 2024 14:15:03 +0100 Subject: [PATCH 09/23] folders and index files for each tut section --- .../tutorials/02-import_data/index.rst | 68 ++++ .../user_guide/tutorials/03-mesh/index.rst | 41 +++ .../tutorials/04-transform_data/index.rst | 35 +++ .../user_guide/tutorials/05-plot/index.rst | 41 +++ .../user_guide/tutorials/06-animate/index.rst | 21 ++ .../tutorials/07-export_data/index.rst | 21 ++ .../08-enriching_dpf_capabilities/index.rst | 42 +++ .../tutorials/09-distributed_files/index.rst | 23 ++ .../tutorials/10-dpf_server/index.rst | 21 ++ .../tutorials/11-licensing/index.rst | 21 ++ .../tutorials/other_tutorials_index.rst | 297 ++---------------- 11 files changed, 367 insertions(+), 264 deletions(-) create mode 100644 doc/source/user_guide/tutorials/02-import_data/index.rst create mode 100644 doc/source/user_guide/tutorials/03-mesh/index.rst create mode 100644 doc/source/user_guide/tutorials/04-transform_data/index.rst create mode 100644 doc/source/user_guide/tutorials/05-plot/index.rst create mode 100644 doc/source/user_guide/tutorials/06-animate/index.rst create mode 100644 doc/source/user_guide/tutorials/07-export_data/index.rst create mode 100644 doc/source/user_guide/tutorials/08-enriching_dpf_capabilities/index.rst create mode 100644 doc/source/user_guide/tutorials/09-distributed_files/index.rst create mode 100644 doc/source/user_guide/tutorials/10-dpf_server/index.rst create mode 100644 doc/source/user_guide/tutorials/11-licensing/index.rst diff --git a/doc/source/user_guide/tutorials/02-import_data/index.rst b/doc/source/user_guide/tutorials/02-import_data/index.rst new file mode 100644 index 0000000000..9215727d52 --- /dev/null +++ b/doc/source/user_guide/tutorials/02-import_data/index.rst @@ -0,0 +1,68 @@ +.. _ref_tutorials_others_import_data: + +Import Data +----------- + +From user input +*************** + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Import data from csv file + :link: ref_tutorials + :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 + + .. grid-item-card:: Create a mesh from scratch + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +From result files +***************** + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Extract and explore results metadata + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Extract and explore results + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Narrow down data (scoping tutorial) + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/03-mesh/index.rst b/doc/source/user_guide/tutorials/03-mesh/index.rst new file mode 100644 index 0000000000..c4095f515a --- /dev/null +++ b/doc/source/user_guide/tutorials/03-mesh/index.rst @@ -0,0 +1,41 @@ +.. _ref_tutorials_others_mesh: + +Mesh +---- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Read the mesh metadata + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Read the mesh + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Read a subpart of the mesh + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Split the mesh + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: diff --git a/doc/source/user_guide/tutorials/04-transform_data/index.rst b/doc/source/user_guide/tutorials/04-transform_data/index.rst new file mode 100644 index 0000000000..ee1478c357 --- /dev/null +++ b/doc/source/user_guide/tutorials/04-transform_data/index.rst @@ -0,0 +1,35 @@ +.. _ref_tutorials_others_transform_data: + +Transform data +-------------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Using operators + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Create a workflow + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Mathematical operations with PyDPF-Core data storage structures + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/05-plot/index.rst b/doc/source/user_guide/tutorials/05-plot/index.rst new file mode 100644 index 0000000000..bb861b6e52 --- /dev/null +++ b/doc/source/user_guide/tutorials/05-plot/index.rst @@ -0,0 +1,41 @@ +.. _ref_tutorials_others_plot: + +Plot +---- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Plotting meshes + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Plotting data on the mesh + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Plotting data on specific placements + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Plotting a graph + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: diff --git a/doc/source/user_guide/tutorials/06-animate/index.rst b/doc/source/user_guide/tutorials/06-animate/index.rst new file mode 100644 index 0000000000..0ecb7bb18c --- /dev/null +++ b/doc/source/user_guide/tutorials/06-animate/index.rst @@ -0,0 +1,21 @@ +.. _ref_tutorials_others_animate: + +Animate +------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Animate data + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/07-export_data/index.rst b/doc/source/user_guide/tutorials/07-export_data/index.rst new file mode 100644 index 0000000000..b911f36fb7 --- /dev/null +++ b/doc/source/user_guide/tutorials/07-export_data/index.rst @@ -0,0 +1,21 @@ +.. _ref_tutorials_others_export_data: + +Export data +----------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Export to XXX + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/08-enriching_dpf_capabilities/index.rst b/doc/source/user_guide/tutorials/08-enriching_dpf_capabilities/index.rst new file mode 100644 index 0000000000..160e10e0b8 --- /dev/null +++ b/doc/source/user_guide/tutorials/08-enriching_dpf_capabilities/index.rst @@ -0,0 +1,42 @@ +.. _ref_tutorials_others_enriching: + +Enriching DPF capabilities +-------------------------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Create custom operators and plugins + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Configure DPF plugins load + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Create a plug-in package with multiple operators + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Create a plug-in package that has third-party dependencies + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/09-distributed_files/index.rst b/doc/source/user_guide/tutorials/09-distributed_files/index.rst new file mode 100644 index 0000000000..1f4285b77e --- /dev/null +++ b/doc/source/user_guide/tutorials/09-distributed_files/index.rst @@ -0,0 +1,23 @@ +.. _ref_tutorials_others_distributed_files: + +Post-process distributed files +------------------------------ + + .. grid-item-card:: Post process data on distributed processes + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + + .. grid-item-card:: Create a custom workflow on distributed processes + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/10-dpf_server/index.rst b/doc/source/user_guide/tutorials/10-dpf_server/index.rst new file mode 100644 index 0000000000..85bab65e01 --- /dev/null +++ b/doc/source/user_guide/tutorials/10-dpf_server/index.rst @@ -0,0 +1,21 @@ +.. _ref_tutorials_others_dpf_server: + +DPF server +---------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Switch between local and remote server + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/11-licensing/index.rst b/doc/source/user_guide/tutorials/11-licensing/index.rst new file mode 100644 index 0000000000..21458718bc --- /dev/null +++ b/doc/source/user_guide/tutorials/11-licensing/index.rst @@ -0,0 +1,21 @@ +.. _ref_tutorials_others_licensing: + +Licensing +--------- + +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Access Entry and Premium Capabilities + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: + diff --git a/doc/source/user_guide/tutorials/other_tutorials_index.rst b/doc/source/user_guide/tutorials/other_tutorials_index.rst index af77b56637..be3f553a39 100644 --- a/doc/source/user_guide/tutorials/other_tutorials_index.rst +++ b/doc/source/user_guide/tutorials/other_tutorials_index.rst @@ -9,278 +9,47 @@ understanding the fundamental PyDPF-Core functionalities and clarify some concep They are categorised based on PyDPF-Core usage : -Import Data ------------ +.. include:: 02-import_data/index.rst + :end-before: toctree -From user input -*************** +.. include:: 03-mesh/index.rst + :end-before: toctree -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 +.. include:: 04-transform_data/index.rst + :end-before: toctree - .. grid-item-card:: Import data from csv file - :link: ref_tutorials - :link-type: ref - :text-align: center +.. include:: 05-plot/index.rst + :end-before: toctree - This tutorial +.. include:: 06-animate/index.rst + :end-before: toctree - .. grid-item-card:: Create a data storage structure from scratch - :link: ref_tutorials - :link-type: ref - :text-align: center +.. include:: 07-export_data/index.rst + :end-before: toctree - This tutorial +.. include:: 08-enriching_dpf_capabilities/index.rst + :end-before: toctree - .. grid-item-card:: Create a mesh from scratch - :link: ref_tutorials - :link-type: ref - :text-align: center +.. include:: 09-distributed_files/index.rst + :end-before: toctree - This tutorial +.. include:: 10-dpf_server/index.rst + :end-before: toctree -From result files -***************** +.. include:: 11-licensing/index.rst + :end-before: toctree -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 +.. toctree:: + :maxdepth: 2 + :hidden: - .. grid-item-card:: Extract and explore results metadata - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Extract and explore results - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Narrow down data (scoping tutorial) - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -Mesh ----- - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Read the mesh metadata - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Read the mesh - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Read a subpart of the mesh - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Split the mesh - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -Transform data --------------- - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Using operators - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Create a workflow - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Mathematical operations with PyDPF-Core data storage structures - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -Plot ----- - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Plotting meshes - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Plotting data on the mesh - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Plotting data on specific placements - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Plotting a graph - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -Animate -------- - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Animate data - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -Export data ------------ - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Export to XXX - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - -Enriching DPF capabilities --------------------------- - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Create custom operators and plugins - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Configure DPF plugins load - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Create a plug-in package with multiple operators - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Create a plug-in package that has third-party dependencies - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -Post-process distributed files ------------------------------- - - .. grid-item-card:: Post process data on distributed processes - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - - .. grid-item-card:: Create a custom workflow on distributed processes - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -DPF server ----------- - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Switch between local and remote server - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - -Licensing ---------- - -.. grid:: 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Access Entry and Premium Capabilities - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial \ No newline at end of file + 02-import_data/index.rst + 03-mesh/index.rst + 04-transform_data/index.rst + 05-plot/index.rst + 06-animate/index.rst + 07-export_data/index.rst + 08-enriching_dpf_capabilities/index.rst + 09-distributed_files/index.rst + 10-dpf_server/index.rst + 11-licensing/index.rst \ No newline at end of file From 456b54d8681249df09b65ea22763e7bb63e98f12 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 7 Nov 2024 14:51:10 +0100 Subject: [PATCH 10/23] update distributed files section grid --- .../user_guide/tutorials/09-distributed_files/index.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/source/user_guide/tutorials/09-distributed_files/index.rst b/doc/source/user_guide/tutorials/09-distributed_files/index.rst index 1f4285b77e..ba43fa20a2 100644 --- a/doc/source/user_guide/tutorials/09-distributed_files/index.rst +++ b/doc/source/user_guide/tutorials/09-distributed_files/index.rst @@ -3,6 +3,11 @@ Post-process distributed files ------------------------------ +.. grid:: 2 + :gutter: 2 + :padding: 2 + :margin: 2 + .. grid-item-card:: Post process data on distributed processes :link: ref_tutorials :link-type: ref From 3421141f2e49e3b864473c6dde711a1a16ec11eb Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Fri, 8 Nov 2024 17:20:55 +0100 Subject: [PATCH 11/23] updates --- doc/source/user_guide/index.rst | 69 +++++------ doc/source/user_guide/tutorials/index.rst | 109 ++++++++++++++++-- .../tutorials/other_tutorials_index.rst | 55 --------- 3 files changed, 125 insertions(+), 108 deletions(-) delete mode 100644 doc/source/user_guide/tutorials/other_tutorials_index.rst diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 87c6cabb66..b7eaba7edd 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -4,27 +4,24 @@ User guide ========== -PyDPF-Core is a Python client API for accessing DPF postprocessing -capabilities. The ``ansys.dpf.core`` package makes highly efficient -computation, customization, and remote postprocessing accessible in Python. +**DPF** provides numerical simulation users and engineers with a toolbox for accessing and +transforming data. -The goals of this section are to: +**PyDPF-Core** is a Python client API for accessing DPF +capabilities. The ``ansys.dpf.core`` package makes highly efficient +computation, customization, and remote data processing accessible in Python. - - Describe the most-used DPF entities and how they can help you to access and modify solver data. - - Provide simple how-tos for tackling the most common use cases. +The goals of this section are to: -.. include:: - concepts/index.rst + - Describe some DPF entities and how they can help you to access and modify solver data. + - Provide detailed tutorials to demonstrate PyDPF-Core functionalities. + - Explain how to resolve the most common issues encountered when using PyDPF-Core .. include:: tutorials/index.rst .. include:: - main_entities.rst - -.. include:: - how_to.rst - + concepts/index.rst Troubleshooting --------------- @@ -55,45 +52,31 @@ Troubleshooting :text-align: center -.. toctree:: - :maxdepth: 2 - :hidden: - :caption: Concepts - - concepts/concepts.rst - concepts/waysofusing.rst - concepts/stepbystep.rst - .. toctree:: :maxdepth: 2 :hidden: :caption: Tutorials tutorials/basic_tutorial_index.rst - tutorials/other_tutorials_index.rst - -.. toctree:: - :maxdepth: 2 - :hidden: - :caption: DPF most-used entities - - model - operators - fields_container - + tutorials/02-import_data/index.rst + tutorials/03-mesh/index.rst + tutorials/04-transform_data/index.rst + tutorials/05-plot/index.rst + tutorials/06-animate/index.rst + tutorials/07-export_data/index.rst + tutorials/08-enriching_dpf_capabilities/index.rst + tutorials/09-distributed_files/index.rst + tutorials/10-dpf_server/index.rst + tutorials/11-licensing/index.rst .. toctree:: - :maxdepth: 2 - :hidden: - :caption: How-tos - - plotting.rst - custom_operators.rst - dpf_server.rst - server_types.rst - server_context.rst - xmlfiles.rst + :maxdepth: 2 + :hidden: + :caption: Concepts + concepts/concepts.rst + concepts/waysofusing.rst + concepts/stepbystep.rst .. toctree:: :maxdepth: 3 diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index d5b69a9b47..7da611859e 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -3,28 +3,117 @@ Tutorials --------- -The tutorials go through the steps required to access, analyze, -and transform simulation data using PyDPF-Core. +The tutorials cover specifics features with detailed demonstrations to help +understanding the fundamental PyDPF-Core functionalities and clarify some concepts. +They are designed to teach how to perform a task, providing explanations at each stage. -Tutorials are more substantive and complex than examples. They are designed to teach how to perform a task and understand -the underlying concepts, providing detailed explanations at each stage, whereas examples showcase end-to-end specific processes. +:fa:`person-running` Beginner's guide +************************************* -.. grid:: 1 1 2 2 +New to PyDPF-Core? Check our beginner's tutorials. They offer an overview +of our package background so you can understand how to work with it. + +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 - .. grid-item-card:: :fa:`person-running` Onboarding + .. grid-item-card:: PyDPF-Core language fundamentals + :link: ref_tutorials_basic + :link-type: ref + :text-align: center + + These tutorials gives you an overview on how to use PyDPF-Core API + + .. grid-item-card:: Processing data basics + :link: ref_tutorials_others + :link-type: ref + :text-align: center + + These tutorials shows the basics on how data can be manipulated with PyDPF-Core. + + .. grid-item-card:: Post processing simulations basics + :link: ref_tutorials_others + :link-type: ref + :text-align: center + + This tutorial shows a basic post-processing procedure using PyDPf-Core + +:fa:`book-open-reader` Features usage +************************************* + +.. grid:: 1 1 3 3 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Import Data on DPF + :link: ref_tutorials_basic + :link-type: ref + :text-align: center + + These tutorials demonstrate how to represent data in DPF: either from manual input either form result files. + + .. grid-item-card:: Export data from DPF + :link: ref_tutorials_others + :link-type: ref + :text-align: center + + These tutorials provides demonstrations on how to export data from your manipulation. + + .. grid-item-card:: Transform data with PyDPF-Core + :link: ref_tutorials_basic + :link-type: ref + :text-align: center + + These tutorials demonstrate how to transform and operate on the data to obtain the desired input. + + .. grid-item-card:: Mesh analysis + :link: ref_tutorials_others + :link-type: ref + :text-align: center + + These tutorials provides detailed demonstrations on how to explore the simulation models mesh. + + .. grid-item-card:: Plot + :link: ref_tutorials_others + :link-type: ref + :text-align: center + + These tutorials shows how to visualise the data in plots. + + .. grid-item-card:: Animate + :link: ref_tutorials_basic + :link-type: ref + :text-align: center + + These tutorials shows how to visualise the data in an animation. + + .. grid-item-card:: Enriching DPF capabilities + :link: ref_tutorials_basic + :link-type: ref + :text-align: center + + These tutorials demonstrate how to enhance DPF capabilities by creating new operator’s libraries. + + .. grid-item-card:: Post-process distributed files + :link: ref_tutorials_others + :link-type: ref + :text-align: center + + These tutorials provides demonstrations on how to use PyDPF-Core with distributed files. + + .. grid-item-card:: DPF server :link: ref_tutorials_basic :link-type: ref :text-align: center - New to PyDPF-Core? Check our beginner's tutorial. It offers an overview - of our basic key features and links to additional tutorials. + These tutorial explains how to manipulate DPF client-server architecture - .. grid-item-card:: :fa:`book-open-reader` Fundamentals and usage + .. grid-item-card:: Licensing :link: ref_tutorials_others :link-type: ref :text-align: center - These tutorials provides detailed demonstrations on PyDPF-Core key features. + These tutorials provide detailed demonstrations on how to access + the Entry and Premium licensing capabilities \ No newline at end of file diff --git a/doc/source/user_guide/tutorials/other_tutorials_index.rst b/doc/source/user_guide/tutorials/other_tutorials_index.rst deleted file mode 100644 index be3f553a39..0000000000 --- a/doc/source/user_guide/tutorials/other_tutorials_index.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. _ref_tutorials_others: - -====================== -Fundamentals and usage -====================== - -These tutorials cover specifics features with detailed demonstrations to help -understanding the fundamental PyDPF-Core functionalities and clarify some concepts. - -They are categorised based on PyDPF-Core usage : - -.. include:: 02-import_data/index.rst - :end-before: toctree - -.. include:: 03-mesh/index.rst - :end-before: toctree - -.. include:: 04-transform_data/index.rst - :end-before: toctree - -.. include:: 05-plot/index.rst - :end-before: toctree - -.. include:: 06-animate/index.rst - :end-before: toctree - -.. include:: 07-export_data/index.rst - :end-before: toctree - -.. include:: 08-enriching_dpf_capabilities/index.rst - :end-before: toctree - -.. include:: 09-distributed_files/index.rst - :end-before: toctree - -.. include:: 10-dpf_server/index.rst - :end-before: toctree - -.. include:: 11-licensing/index.rst - :end-before: toctree - -.. toctree:: - :maxdepth: 2 - :hidden: - - 02-import_data/index.rst - 03-mesh/index.rst - 04-transform_data/index.rst - 05-plot/index.rst - 06-animate/index.rst - 07-export_data/index.rst - 08-enriching_dpf_capabilities/index.rst - 09-distributed_files/index.rst - 10-dpf_server/index.rst - 11-licensing/index.rst \ No newline at end of file From 4a2e9d32dcd3938bdff42303d8597f54003538cc Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 12 Nov 2024 10:35:50 +0100 Subject: [PATCH 12/23] layout changes --- doc/source/user_guide/index.rst | 22 ++++---- .../tutorials/01-language_and_usage/index.rst | 13 +++++ .../tutorials/02-processing_basics/index.rst | 51 +++++++++++++++++++ .../01-main-steps.rst | 2 +- .../03-post_processing_basics/index.rst | 15 ++++++ .../index.rst | 5 +- .../tutorials/{03-mesh => 05-mesh}/index.rst | 5 +- .../index.rst | 5 +- .../tutorials/07-export_data/index.rst | 5 +- .../tutorials/{05-plot => 08-plot}/index.rst | 5 +- .../{06-animate => 09-animate}/index.rst | 5 +- .../index.rst | 5 +- .../index.rst | 5 +- .../index.rst | 5 +- .../{11-licensing => 13-licensing}/index.rst | 5 +- doc/source/user_guide/tutorials/index.rst | 29 ++++++----- 16 files changed, 137 insertions(+), 45 deletions(-) create mode 100644 doc/source/user_guide/tutorials/01-language_and_usage/index.rst create mode 100644 doc/source/user_guide/tutorials/02-processing_basics/index.rst rename doc/source/user_guide/tutorials/{ => 03-post_processing_basics}/01-main-steps.rst (99%) create mode 100644 doc/source/user_guide/tutorials/03-post_processing_basics/index.rst rename doc/source/user_guide/tutorials/{02-import_data => 04-import_data}/index.rst (95%) rename doc/source/user_guide/tutorials/{03-mesh => 05-mesh}/index.rst (95%) rename doc/source/user_guide/tutorials/{04-transform_data => 06-transform_data}/index.rst (90%) rename doc/source/user_guide/tutorials/{05-plot => 08-plot}/index.rst (95%) rename doc/source/user_guide/tutorials/{06-animate => 09-animate}/index.rst (85%) rename doc/source/user_guide/tutorials/{08-enriching_dpf_capabilities => 10-enriching_dpf_capabilities}/index.rst (90%) rename doc/source/user_guide/tutorials/{09-distributed_files => 11-distributed_files}/index.rst (82%) rename doc/source/user_guide/tutorials/{10-dpf_server => 12-dpf_server}/index.rst (84%) rename doc/source/user_guide/tutorials/{11-licensing => 13-licensing}/index.rst (85%) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index b7eaba7edd..c16060bbb7 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -57,17 +57,19 @@ Troubleshooting :hidden: :caption: Tutorials - tutorials/basic_tutorial_index.rst - tutorials/02-import_data/index.rst - tutorials/03-mesh/index.rst - tutorials/04-transform_data/index.rst - tutorials/05-plot/index.rst - tutorials/06-animate/index.rst + tutorials/01-language_and_usage/index.rst + tutorials/02-processing_basics/index.rst + tutorials/03-post_processing_basics/index.rst + tutorials/04-import_data/index.rst + tutorials/05-mesh/index.rst + tutorials/06-transform_data/index.rst tutorials/07-export_data/index.rst - tutorials/08-enriching_dpf_capabilities/index.rst - tutorials/09-distributed_files/index.rst - tutorials/10-dpf_server/index.rst - tutorials/11-licensing/index.rst + tutorials/08-plot/index.rst + tutorials/09-animate/index.rst + tutorials/10-enriching_dpf_capabilities/index.rst + tutorials/11-distributed_files/index.rst + tutorials/12-dpf_server/index.rst + tutorials/13-licensing/index.rst .. toctree:: :maxdepth: 2 diff --git a/doc/source/user_guide/tutorials/01-language_and_usage/index.rst b/doc/source/user_guide/tutorials/01-language_and_usage/index.rst new file mode 100644 index 0000000000..441c3e96e3 --- /dev/null +++ b/doc/source/user_guide/tutorials/01-language_and_usage/index.rst @@ -0,0 +1,13 @@ +.. _ref_tutorials_language_and_usage: + +============================= +PyDPF-Core language and usage +============================= + +This tutorial gives you an overview on how the the PyDPF-COre API can be used. +For more detailed information on each module and function, see :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 new file mode 100644 index 0000000000..f134c651ca --- /dev/null +++ b/doc/source/user_guide/tutorials/02-processing_basics/index.rst @@ -0,0 +1,51 @@ +.. _ref_tutorials_processing_basics: + +====================== +Processing data basics +====================== + +When DPF employ operators to manipulate the data,it uses data containers +to store and return it. 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) + +The tutorials in this section presents the basics on how to create and manipulate data +with those structures. + +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:: Creating 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:: Creating DPF collections + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial shows how to create and work with some DPF collections: + FieldsContainer, MeshesContainer, ScopingsContainer + + .. 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 diff --git a/doc/source/user_guide/tutorials/01-main-steps.rst b/doc/source/user_guide/tutorials/03-post_processing_basics/01-main-steps.rst similarity index 99% rename from doc/source/user_guide/tutorials/01-main-steps.rst rename to doc/source/user_guide/tutorials/03-post_processing_basics/01-main-steps.rst index 67a2d5dec4..43ef9b3a36 100644 --- a/doc/source/user_guide/tutorials/01-main-steps.rst +++ b/doc/source/user_guide/tutorials/03-post_processing_basics/01-main-steps.rst @@ -44,7 +44,7 @@ be used to visualize and analyze simulation results: :link-type: ref :text-align: center - Extract data + Export data .. _tutorials_main_steps_1: 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 new file mode 100644 index 0000000000..d47dbbdce0 --- /dev/null +++ b/doc/source/user_guide/tutorials/03-post_processing_basics/index.rst @@ -0,0 +1,15 @@ +.. _ref_tutorials_post_processing_basics: + +====================== +Post processing basics +====================== + +This tutorial demonstrate a basic post-processing procedure +using PyDPf-Core based on its usual main steps. + +When post-processing with PyDPf-Core, the goal is to transform simulation data +into output data that can be used to visualize and analyze simulation results. + +.. include:: 01-main-steps.rst + + diff --git a/doc/source/user_guide/tutorials/02-import_data/index.rst b/doc/source/user_guide/tutorials/04-import_data/index.rst similarity index 95% rename from doc/source/user_guide/tutorials/02-import_data/index.rst rename to doc/source/user_guide/tutorials/04-import_data/index.rst index 9215727d52..f9c37741a1 100644 --- a/doc/source/user_guide/tutorials/02-import_data/index.rst +++ b/doc/source/user_guide/tutorials/04-import_data/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_import_data: +.. _ref_tutorials_import_data: +=========== Import Data ------------ +=========== From user input *************** diff --git a/doc/source/user_guide/tutorials/03-mesh/index.rst b/doc/source/user_guide/tutorials/05-mesh/index.rst similarity index 95% rename from doc/source/user_guide/tutorials/03-mesh/index.rst rename to doc/source/user_guide/tutorials/05-mesh/index.rst index c4095f515a..0509d1f09c 100644 --- a/doc/source/user_guide/tutorials/03-mesh/index.rst +++ b/doc/source/user_guide/tutorials/05-mesh/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_mesh: +.. _ref_tutorials_mesh: +==== Mesh ----- +==== .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/04-transform_data/index.rst b/doc/source/user_guide/tutorials/06-transform_data/index.rst similarity index 90% rename from doc/source/user_guide/tutorials/04-transform_data/index.rst rename to doc/source/user_guide/tutorials/06-transform_data/index.rst index ee1478c357..561b44fed1 100644 --- a/doc/source/user_guide/tutorials/04-transform_data/index.rst +++ b/doc/source/user_guide/tutorials/06-transform_data/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_transform_data: +.. _ref_tutorials_transform_data: +============== Transform data --------------- +============== .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/07-export_data/index.rst b/doc/source/user_guide/tutorials/07-export_data/index.rst index b911f36fb7..585b4f8060 100644 --- a/doc/source/user_guide/tutorials/07-export_data/index.rst +++ b/doc/source/user_guide/tutorials/07-export_data/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_export_data: +.. _ref_tutorials_export_data: +=========== Export data ------------ +=========== .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/05-plot/index.rst b/doc/source/user_guide/tutorials/08-plot/index.rst similarity index 95% rename from doc/source/user_guide/tutorials/05-plot/index.rst rename to doc/source/user_guide/tutorials/08-plot/index.rst index bb861b6e52..a4640c20a3 100644 --- a/doc/source/user_guide/tutorials/05-plot/index.rst +++ b/doc/source/user_guide/tutorials/08-plot/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_plot: +.. _ref_tutorials_plot: +==== Plot ----- +==== .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/06-animate/index.rst b/doc/source/user_guide/tutorials/09-animate/index.rst similarity index 85% rename from doc/source/user_guide/tutorials/06-animate/index.rst rename to doc/source/user_guide/tutorials/09-animate/index.rst index 0ecb7bb18c..c0bbc86cd2 100644 --- a/doc/source/user_guide/tutorials/06-animate/index.rst +++ b/doc/source/user_guide/tutorials/09-animate/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_animate: +.. _ref_tutorials_animate: +======= Animate -------- +======= .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/08-enriching_dpf_capabilities/index.rst b/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst similarity index 90% rename from doc/source/user_guide/tutorials/08-enriching_dpf_capabilities/index.rst rename to doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst index 160e10e0b8..8ac4ccacc9 100644 --- a/doc/source/user_guide/tutorials/08-enriching_dpf_capabilities/index.rst +++ b/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_enriching: +.. _ref_tutorials_enriching: +========================== Enriching DPF capabilities --------------------------- +========================== .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/09-distributed_files/index.rst b/doc/source/user_guide/tutorials/11-distributed_files/index.rst similarity index 82% rename from doc/source/user_guide/tutorials/09-distributed_files/index.rst rename to doc/source/user_guide/tutorials/11-distributed_files/index.rst index ba43fa20a2..00c4933505 100644 --- a/doc/source/user_guide/tutorials/09-distributed_files/index.rst +++ b/doc/source/user_guide/tutorials/11-distributed_files/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_distributed_files: +.. _ref_tutorials_distributed_files: +============================== Post-process distributed files ------------------------------- +============================== .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/10-dpf_server/index.rst b/doc/source/user_guide/tutorials/12-dpf_server/index.rst similarity index 84% rename from doc/source/user_guide/tutorials/10-dpf_server/index.rst rename to doc/source/user_guide/tutorials/12-dpf_server/index.rst index 85bab65e01..610c7d8120 100644 --- a/doc/source/user_guide/tutorials/10-dpf_server/index.rst +++ b/doc/source/user_guide/tutorials/12-dpf_server/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_dpf_server: +.. _ref_tutorials_dpf_server: +========== DPF server ----------- +========== .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/11-licensing/index.rst b/doc/source/user_guide/tutorials/13-licensing/index.rst similarity index 85% rename from doc/source/user_guide/tutorials/11-licensing/index.rst rename to doc/source/user_guide/tutorials/13-licensing/index.rst index 21458718bc..16e7738ec2 100644 --- a/doc/source/user_guide/tutorials/11-licensing/index.rst +++ b/doc/source/user_guide/tutorials/13-licensing/index.rst @@ -1,7 +1,8 @@ -.. _ref_tutorials_others_licensing: +.. _ref_tutorials_licensing: +========= Licensing ---------- +========= .. grid:: 2 :gutter: 2 diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 7da611859e..844d82c62f 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -19,21 +19,22 @@ of our package background so you can understand how to work with it. :margin: 2 .. grid-item-card:: PyDPF-Core language fundamentals - :link: ref_tutorials_basic + :link: ref_tutorials_language_and_usage :link-type: ref :text-align: center These tutorials gives you an overview on how to use PyDPF-Core API .. grid-item-card:: Processing data basics - :link: ref_tutorials_others + :link: ref_tutorials_processing_basics :link-type: ref :text-align: center - These tutorials shows the basics on how data can be manipulated with PyDPF-Core. + These tutorials shows the basics on how data can be manipulated with PyDPF-Core: + How to create data storage structures, basic mathematics with the data... .. grid-item-card:: Post processing simulations basics - :link: ref_tutorials_others + :link: ref_tutorials_post_processing_basics :link-type: ref :text-align: center @@ -48,70 +49,70 @@ of our package background so you can understand how to work with it. :margin: 2 .. grid-item-card:: Import Data on DPF - :link: ref_tutorials_basic + :link: ref_tutorials_import_data :link-type: ref :text-align: center These tutorials demonstrate how to represent data in DPF: either from manual input either form result files. .. grid-item-card:: Export data from DPF - :link: ref_tutorials_others + :link: ref_tutorials_export_data :link-type: ref :text-align: center These tutorials provides demonstrations on how to export data from your manipulation. .. grid-item-card:: Transform data with PyDPF-Core - :link: ref_tutorials_basic + :link: ref_tutorials_transform_data :link-type: ref :text-align: center These tutorials demonstrate how to transform and operate on the data to obtain the desired input. .. grid-item-card:: Mesh analysis - :link: ref_tutorials_others + :link: ref_tutorials_mesh :link-type: ref :text-align: center These tutorials provides detailed demonstrations on how to explore the simulation models mesh. .. grid-item-card:: Plot - :link: ref_tutorials_others + :link: ref_tutorials_plot :link-type: ref :text-align: center These tutorials shows how to visualise the data in plots. .. grid-item-card:: Animate - :link: ref_tutorials_basic + :link: ref_tutorials_animate :link-type: ref :text-align: center These tutorials shows how to visualise the data in an animation. .. grid-item-card:: Enriching DPF capabilities - :link: ref_tutorials_basic + :link: ref_tutorials_enriching :link-type: ref :text-align: center These tutorials demonstrate how to enhance DPF capabilities by creating new operator’s libraries. .. grid-item-card:: Post-process distributed files - :link: ref_tutorials_others + :link: ref_tutorials_distributed_files :link-type: ref :text-align: center These tutorials provides demonstrations on how to use PyDPF-Core with distributed files. .. grid-item-card:: DPF server - :link: ref_tutorials_basic + :link: ref_tutorials_dpf_server :link-type: ref :text-align: center These tutorial explains how to manipulate DPF client-server architecture .. grid-item-card:: Licensing - :link: ref_tutorials_others + :link: ref_tutorials_licensing :link-type: ref :text-align: center From db55259583f4a0667eedfe979eeffb6966ca389e Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 12 Nov 2024 10:59:03 +0100 Subject: [PATCH 13/23] updates on the index cards --- .../user_guide/tutorials/00-overview.rst | 5 --- .../tutorials/01-language_and_usage/index.rst | 5 ++- .../tutorials/04-import_data/index.rst | 5 ++- .../user_guide/tutorials/05-mesh/index.rst | 2 +- .../tutorials/06-transform_data/index.rst | 2 +- .../tutorials/07-export_data/index.rst | 2 +- .../user_guide/tutorials/08-plot/index.rst | 2 +- .../user_guide/tutorials/09-animate/index.rst | 2 +- .../10-enriching_dpf_capabilities/index.rst | 2 +- .../tutorials/11-distributed_files/index.rst | 2 +- .../tutorials/12-dpf_server/index.rst | 2 +- .../tutorials/13-licensing/index.rst | 2 +- .../tutorials/basic_tutorial_index.rst | 40 ----------------- doc/source/user_guide/tutorials/index.rst | 43 +++++++++++-------- 14 files changed, 42 insertions(+), 74 deletions(-) delete mode 100644 doc/source/user_guide/tutorials/00-overview.rst delete mode 100644 doc/source/user_guide/tutorials/basic_tutorial_index.rst diff --git a/doc/source/user_guide/tutorials/00-overview.rst b/doc/source/user_guide/tutorials/00-overview.rst deleted file mode 100644 index 826cc9bea1..0000000000 --- a/doc/source/user_guide/tutorials/00-overview.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _tutorials_overview: - -Overview --------- - diff --git a/doc/source/user_guide/tutorials/01-language_and_usage/index.rst b/doc/source/user_guide/tutorials/01-language_and_usage/index.rst index 441c3e96e3..752a106ef2 100644 --- a/doc/source/user_guide/tutorials/01-language_and_usage/index.rst +++ b/doc/source/user_guide/tutorials/01-language_and_usage/index.rst @@ -5,7 +5,10 @@ PyDPF-Core language and usage ============================= This tutorial gives you an overview on how the the PyDPF-COre API can be used. -For more detailed information on each module and function, see :ref:`api_section`. +Here you will learn the different ways to interact with data by calling PyDPF-Core +commands and operators. + +For more detailed information on each module and function, see :ref:`ref_api_section`. diff --git a/doc/source/user_guide/tutorials/04-import_data/index.rst b/doc/source/user_guide/tutorials/04-import_data/index.rst index f9c37741a1..e1f6a8aa0b 100644 --- a/doc/source/user_guide/tutorials/04-import_data/index.rst +++ b/doc/source/user_guide/tutorials/04-import_data/index.rst @@ -4,10 +4,13 @@ Import Data =========== +These tutorials demonstrate how to represent data in DPF: either from manual input either +form simulation result files. + From user input *************** -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/05-mesh/index.rst b/doc/source/user_guide/tutorials/05-mesh/index.rst index 0509d1f09c..94226df41f 100644 --- 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 ==== -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/06-transform_data/index.rst b/doc/source/user_guide/tutorials/06-transform_data/index.rst index 561b44fed1..17c322400e 100644 --- a/doc/source/user_guide/tutorials/06-transform_data/index.rst +++ b/doc/source/user_guide/tutorials/06-transform_data/index.rst @@ -4,7 +4,7 @@ Transform data ============== -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/07-export_data/index.rst b/doc/source/user_guide/tutorials/07-export_data/index.rst index 585b4f8060..537fa5d47d 100644 --- a/doc/source/user_guide/tutorials/07-export_data/index.rst +++ b/doc/source/user_guide/tutorials/07-export_data/index.rst @@ -4,7 +4,7 @@ Export data =========== -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/08-plot/index.rst b/doc/source/user_guide/tutorials/08-plot/index.rst index a4640c20a3..7f7601a16e 100644 --- a/doc/source/user_guide/tutorials/08-plot/index.rst +++ b/doc/source/user_guide/tutorials/08-plot/index.rst @@ -4,7 +4,7 @@ Plot ==== -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/09-animate/index.rst b/doc/source/user_guide/tutorials/09-animate/index.rst index c0bbc86cd2..08a45a1689 100644 --- a/doc/source/user_guide/tutorials/09-animate/index.rst +++ b/doc/source/user_guide/tutorials/09-animate/index.rst @@ -4,7 +4,7 @@ Animate ======= -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst b/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst index 8ac4ccacc9..8dda955fd7 100644 --- a/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst +++ b/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst @@ -4,7 +4,7 @@ Enriching DPF capabilities ========================== -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/11-distributed_files/index.rst b/doc/source/user_guide/tutorials/11-distributed_files/index.rst index 00c4933505..b1385e53e0 100644 --- a/doc/source/user_guide/tutorials/11-distributed_files/index.rst +++ b/doc/source/user_guide/tutorials/11-distributed_files/index.rst @@ -4,7 +4,7 @@ Post-process distributed files ============================== -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/12-dpf_server/index.rst b/doc/source/user_guide/tutorials/12-dpf_server/index.rst index 610c7d8120..4b96296177 100644 --- a/doc/source/user_guide/tutorials/12-dpf_server/index.rst +++ b/doc/source/user_guide/tutorials/12-dpf_server/index.rst @@ -4,7 +4,7 @@ DPF server ========== -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/13-licensing/index.rst b/doc/source/user_guide/tutorials/13-licensing/index.rst index 16e7738ec2..90923740ac 100644 --- a/doc/source/user_guide/tutorials/13-licensing/index.rst +++ b/doc/source/user_guide/tutorials/13-licensing/index.rst @@ -4,7 +4,7 @@ Licensing ========= -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/basic_tutorial_index.rst b/doc/source/user_guide/tutorials/basic_tutorial_index.rst deleted file mode 100644 index 140f733479..0000000000 --- a/doc/source/user_guide/tutorials/basic_tutorial_index.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _ref_tutorials_basic: - -================== -The basic tutorial -================== - -This tutorial guides throughout the basic concepts and features of the PyDPF-Core tool. -It helps to have a Python interpreter for hands-on experience, but all code examples are -executed, so the tutorial can be read off-line as well. - -For a complete description of all the objects and modules, see the :ref:`API reference ` section. - -This page is divided in two sections: - -.. grid:: 1 1 2 2 - :gutter: 2 - :padding: 2 - :margin: 2 - - .. grid-item-card:: Overview - :link: tutorials_overview - :link-type: ref - :text-align: center - - Learn the different ways to interact with data by calling PyDPF-Core commands and operators. - - .. grid-item-card:: Postprocessing main steps - :link: tutorials_main_steps - :link-type: ref - :text-align: center - - How to do a basic prost-processing by transforming simulation data into output - data that can be used to visualize and analyze results - -.. include:: - 00-overview.rst - -.. include:: - 01-main-steps.rst - diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 844d82c62f..3b360cfb3e 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -7,6 +7,12 @@ The tutorials cover specifics features with detailed demonstrations to help understanding the fundamental PyDPF-Core functionalities and clarify some concepts. They are designed to teach how to perform a task, providing explanations at each stage. +It helps to have a Python interpreter for hands-on experience, but all code examples are +executed, so the tutorial can be read off-line as well. + +For a complete description of all the objects and modules, see the :ref:`API reference ` +section. + :fa:`person-running` Beginner's guide ************************************* @@ -23,14 +29,16 @@ of our package background so you can understand how to work with it. :link-type: ref :text-align: center - These tutorials gives you an overview on how to use PyDPF-Core API + 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. .. grid-item-card:: Processing data basics :link: ref_tutorials_processing_basics :link-type: ref :text-align: center - These tutorials shows the basics on how data can be manipulated with PyDPF-Core: + Learn the basics on how data can be manipulated with PyDPF-Core: How to create data storage structures, basic mathematics with the data... .. grid-item-card:: Post processing simulations basics @@ -38,7 +46,7 @@ of our package background so you can understand how to work with it. :link-type: ref :text-align: center - This tutorial shows a basic post-processing procedure using PyDPf-Core + Check a basic post-processing procedure using PyDPf-Core. :fa:`book-open-reader` Features usage ************************************* @@ -53,68 +61,67 @@ of our package background so you can understand how to work with it. :link-type: ref :text-align: center - These tutorials demonstrate how to represent data in DPF: either from manual input either form result files. + Understand how to represent data in DPF: either from manual input either form result files. - .. grid-item-card:: Export data from DPF - :link: ref_tutorials_export_data + .. grid-item-card:: Mesh analysis + :link: ref_tutorials_mesh :link-type: ref :text-align: center - These tutorials provides demonstrations on how to export data from your manipulation. + Learn how to explore the simulation models mesh. .. grid-item-card:: Transform data with PyDPF-Core :link: ref_tutorials_transform_data :link-type: ref :text-align: center - These tutorials demonstrate how to transform and operate on the data to obtain the desired input. + Learn how to transform and operate on data to obtain the desired input. - .. grid-item-card:: Mesh analysis - :link: ref_tutorials_mesh + .. grid-item-card:: Export data from DPF + :link: ref_tutorials_export_data :link-type: ref :text-align: center - These tutorials provides detailed demonstrations on how to explore the simulation models mesh. + Discover the best ways to export data from your manipulation. .. grid-item-card:: Plot :link: ref_tutorials_plot :link-type: ref :text-align: center - These tutorials shows how to visualise the data in plots. + Explore the different approaches to visualise the data in plots. .. grid-item-card:: Animate :link: ref_tutorials_animate :link-type: ref :text-align: center - These tutorials shows how to visualise the data in an animation. + Explore the different approaches to visualise the data in an animation. .. grid-item-card:: Enriching DPF capabilities :link: ref_tutorials_enriching :link-type: ref :text-align: center - These tutorials demonstrate how to enhance DPF capabilities by creating new operator’s libraries. + Discover how to enhance DPF capabilities by creating new operator’s libraries. .. grid-item-card:: Post-process distributed files :link: ref_tutorials_distributed_files :link-type: ref :text-align: center - These tutorials provides demonstrations on how to use PyDPF-Core with distributed files. + Learn how to use PyDPF-Core with distributed files. .. grid-item-card:: DPF server :link: ref_tutorials_dpf_server :link-type: ref :text-align: center - These tutorial explains how to manipulate DPF client-server architecture + Understand how to manipulate DPF client-server architecture .. grid-item-card:: Licensing :link: ref_tutorials_licensing :link-type: ref :text-align: center - These tutorials provide detailed demonstrations on how to access - the Entry and Premium licensing capabilities \ No newline at end of file + Understand how to access the Entry and Premium licensing capabilities \ No newline at end of file From 51fc7b9fc22d66c3a06ff692f79bfb8fc7135206 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 12 Nov 2024 12:04:41 +0100 Subject: [PATCH 14/23] updates on the index pages --- .../tutorials/01-language_and_usage/index.rst | 2 +- .../user_guide/tutorials/04-import_data/index.rst | 2 +- doc/source/user_guide/tutorials/05-mesh/index.rst | 5 +++++ .../tutorials/06-transform_data/index.rst | 13 +++++++++++++ .../user_guide/tutorials/07-export_data/index.rst | 8 +++++++- doc/source/user_guide/tutorials/08-plot/index.rst | 2 ++ .../user_guide/tutorials/09-animate/index.rst | 2 ++ .../10-enriching_dpf_capabilities/index.rst | 13 ++++++------- .../tutorials/11-distributed_files/index.rst | 2 ++ .../user_guide/tutorials/12-dpf_server/index.rst | 2 ++ .../user_guide/tutorials/13-licensing/index.rst | 3 +++ doc/source/user_guide/tutorials/index.rst | 4 ++-- 12 files changed, 46 insertions(+), 12 deletions(-) diff --git a/doc/source/user_guide/tutorials/01-language_and_usage/index.rst b/doc/source/user_guide/tutorials/01-language_and_usage/index.rst index 752a106ef2..0389b19d54 100644 --- a/doc/source/user_guide/tutorials/01-language_and_usage/index.rst +++ b/doc/source/user_guide/tutorials/01-language_and_usage/index.rst @@ -4,7 +4,7 @@ PyDPF-Core language and usage ============================= -This tutorial gives you an overview on how the the PyDPF-COre API can be used. +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. diff --git a/doc/source/user_guide/tutorials/04-import_data/index.rst b/doc/source/user_guide/tutorials/04-import_data/index.rst index e1f6a8aa0b..0eaff2dff1 100644 --- a/doc/source/user_guide/tutorials/04-import_data/index.rst +++ b/doc/source/user_guide/tutorials/04-import_data/index.rst @@ -39,7 +39,7 @@ From user input From result files ***************** -.. grid:: 2 +.. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 diff --git a/doc/source/user_guide/tutorials/05-mesh/index.rst b/doc/source/user_guide/tutorials/05-mesh/index.rst index 94226df41f..3053fdb538 100644 --- a/doc/source/user_guide/tutorials/05-mesh/index.rst +++ b/doc/source/user_guide/tutorials/05-mesh/index.rst @@ -4,6 +4,11 @@ Mesh ==== +The mesh in DPF is represented by the :class:`MeshedRegion` entity. + +These tutorials explains how to explore different attributes of a given mesh with PyDPF-Core. + + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 diff --git a/doc/source/user_guide/tutorials/06-transform_data/index.rst b/doc/source/user_guide/tutorials/06-transform_data/index.rst index 17c322400e..1af0c017fc 100644 --- a/doc/source/user_guide/tutorials/06-transform_data/index.rst +++ b/doc/source/user_guide/tutorials/06-transform_data/index.rst @@ -4,6 +4,19 @@ Transform data ============== +An operator is the main object that is used to create, transform, and stream data in DPF. + +They can perform different modifications with the data: direct mathematical operations, +averaging in the mesh, changes in the model locations .... They can also be chained together +to create more complex operations and customizable results. + +The tutorials in this section aims to explain how to transform and operate on data to obtain +the desired input by using the DPF operators with PyDPF-Core. + +For more information on how to program with PyDPF-Core check the +:ref:`ref_tutorials_language_and_usage` tutorial. + + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 diff --git a/doc/source/user_guide/tutorials/07-export_data/index.rst b/doc/source/user_guide/tutorials/07-export_data/index.rst index 537fa5d47d..c9be8ecd6c 100644 --- a/doc/source/user_guide/tutorials/07-export_data/index.rst +++ b/doc/source/user_guide/tutorials/07-export_data/index.rst @@ -4,12 +4,18 @@ Export data =========== +Data in DPF can be exported to universal file formats, such as VTK, HDF5, and TXT files. +You can use it to generate TH-plots, screenshots, and animations or to create custom result +plots using the `numpy `_ and `matplotlib `_ packages. + +These tutorials explains how to export data from your manipulations with PyDPF-Core. + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 :margin: 2 - .. grid-item-card:: Export to XXX + .. grid-item-card:: HDF5 export :link: ref_tutorials :link-type: ref :text-align: center diff --git a/doc/source/user_guide/tutorials/08-plot/index.rst b/doc/source/user_guide/tutorials/08-plot/index.rst index 7f7601a16e..32f11495e5 100644 --- a/doc/source/user_guide/tutorials/08-plot/index.rst +++ b/doc/source/user_guide/tutorials/08-plot/index.rst @@ -4,6 +4,8 @@ Plot ==== +These tutorials demonstrate some different approaches to visualise the data in plots. + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 diff --git a/doc/source/user_guide/tutorials/09-animate/index.rst b/doc/source/user_guide/tutorials/09-animate/index.rst index 08a45a1689..2bfa5b2f4e 100644 --- a/doc/source/user_guide/tutorials/09-animate/index.rst +++ b/doc/source/user_guide/tutorials/09-animate/index.rst @@ -4,6 +4,8 @@ Animate ======= +These tutorials demonstrate how to visualise the data in an animation. + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 diff --git a/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst b/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst index 8dda955fd7..232c57c2a4 100644 --- a/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst +++ b/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst @@ -4,6 +4,12 @@ Enriching DPF capabilities ========================== +The available DPF capabilities loaded in a DPF application can be enhanced +by creating new operator’s libraries. DPF offers multiple development APIs +depending on your environment. + +These tutorials demonstrate how to develop those plugins for PyDPF-Core (CPython based) + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 @@ -16,13 +22,6 @@ Enriching DPF capabilities This tutorial - .. grid-item-card:: Configure DPF plugins load - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial - .. grid-item-card:: Create a plug-in package with multiple operators :link: ref_tutorials :link-type: ref diff --git a/doc/source/user_guide/tutorials/11-distributed_files/index.rst b/doc/source/user_guide/tutorials/11-distributed_files/index.rst index b1385e53e0..70240e016d 100644 --- a/doc/source/user_guide/tutorials/11-distributed_files/index.rst +++ b/doc/source/user_guide/tutorials/11-distributed_files/index.rst @@ -4,6 +4,8 @@ Post-process distributed files ============================== +These tutorials show how to create workflows on different processes (possibly on different machines) and connect them. + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 diff --git a/doc/source/user_guide/tutorials/12-dpf_server/index.rst b/doc/source/user_guide/tutorials/12-dpf_server/index.rst index 4b96296177..efc4e1bfdb 100644 --- a/doc/source/user_guide/tutorials/12-dpf_server/index.rst +++ b/doc/source/user_guide/tutorials/12-dpf_server/index.rst @@ -4,6 +4,8 @@ DPF server ========== +This tutorial explains how to manipulate DPF client-server architecture + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 diff --git a/doc/source/user_guide/tutorials/13-licensing/index.rst b/doc/source/user_guide/tutorials/13-licensing/index.rst index 90923740ac..e7760c435b 100644 --- a/doc/source/user_guide/tutorials/13-licensing/index.rst +++ b/doc/source/user_guide/tutorials/13-licensing/index.rst @@ -4,6 +4,9 @@ Licensing ========= +This tutorial explains the DPF server licensing logic. Here you +learn about the Entry and Premium licensing capabilities + .. grid:: 1 1 3 3 :gutter: 2 :padding: 2 diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 3b360cfb3e..e828fdee5e 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -68,7 +68,7 @@ of our package background so you can understand how to work with it. :link-type: ref :text-align: center - Learn how to explore the simulation models mesh. + Learn how to explore a mesh in DPF. .. grid-item-card:: Transform data with PyDPF-Core :link: ref_tutorials_transform_data @@ -82,7 +82,7 @@ of our package background so you can understand how to work with it. :link-type: ref :text-align: center - Discover the best ways to export data from your manipulation. + Discover the best ways to export data from your manipulations with PyDPF-Core. .. grid-item-card:: Plot :link: ref_tutorials_plot From 4de2bf105ca68e853d8710f995fc54adb921d2ad Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 12 Nov 2024 16:07:47 +0100 Subject: [PATCH 15/23] updates on the basic tuts --- doc/source/user_guide/index.rst | 6 +-- .../tutorials/01-data_structures/index.rst | 38 ++++++++++++++ .../index.rst | 8 +-- .../tutorials/02-processing_basics/index.rst | 51 ------------------- .../03-post_processing_basics/index.rst | 15 ------ .../01-main-steps.rst | 0 .../tutorials/03-processing_basics/index.rst | 42 +++++++++++++++ .../tutorials/04-import_data/index.rst | 13 ++--- .../user_guide/tutorials/05-mesh/index.rst | 16 +++++- doc/source/user_guide/tutorials/index.rst | 23 ++++----- 10 files changed, 114 insertions(+), 98 deletions(-) create mode 100644 doc/source/user_guide/tutorials/01-data_structures/index.rst rename doc/source/user_guide/tutorials/{01-language_and_usage => 02-language_and_usage}/index.rst (54%) delete mode 100644 doc/source/user_guide/tutorials/02-processing_basics/index.rst delete mode 100644 doc/source/user_guide/tutorials/03-post_processing_basics/index.rst rename doc/source/user_guide/tutorials/{03-post_processing_basics => 03-processing_basics}/01-main-steps.rst (100%) create mode 100644 doc/source/user_guide/tutorials/03-processing_basics/index.rst diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index c16060bbb7..523bd82e0c 100644 --- 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 new file mode 100644 index 0000000000..4a4cd2d011 --- /dev/null +++ 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/01-language_and_usage/index.rst b/doc/source/user_guide/tutorials/02-language_and_usage/index.rst similarity index 54% rename from doc/source/user_guide/tutorials/01-language_and_usage/index.rst rename to doc/source/user_guide/tutorials/02-language_and_usage/index.rst index 0389b19d54..543bdf7e3b 100644 --- a/doc/source/user_guide/tutorials/01-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 deleted file mode 100644 index f134c651ca..0000000000 --- a/doc/source/user_guide/tutorials/02-processing_basics/index.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _ref_tutorials_processing_basics: - -====================== -Processing data basics -====================== - -When DPF employ operators to manipulate the data,it uses data containers -to store and return it. 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) - -The tutorials in this section presents the basics on how to create and manipulate data -with those structures. - -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:: Creating 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:: Creating DPF collections - :link: ref_tutorials - :link-type: ref - :text-align: center - - This tutorial shows how to create and work with some DPF collections: - FieldsContainer, MeshesContainer, ScopingsContainer - - .. 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 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 deleted file mode 100644 index d47dbbdce0..0000000000 --- a/doc/source/user_guide/tutorials/03-post_processing_basics/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _ref_tutorials_post_processing_basics: - -====================== -Post processing basics -====================== - -This tutorial demonstrate a basic post-processing procedure -using PyDPf-Core based on its usual main steps. - -When post-processing with PyDPf-Core, the goal is to transform simulation data -into output data that can be used to visualize and analyze simulation results. - -.. include:: 01-main-steps.rst - - diff --git a/doc/source/user_guide/tutorials/03-post_processing_basics/01-main-steps.rst b/doc/source/user_guide/tutorials/03-processing_basics/01-main-steps.rst similarity index 100% rename from doc/source/user_guide/tutorials/03-post_processing_basics/01-main-steps.rst rename to 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 new file mode 100644 index 0000000000..f7b70f287d --- /dev/null +++ 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. \ No newline at end of file diff --git a/doc/source/user_guide/tutorials/04-import_data/index.rst b/doc/source/user_guide/tutorials/04-import_data/index.rst index 0eaff2dff1..112339d5a5 100644 --- 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 index 3053fdb538..8464839b40 100644 --- 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` entity. +The mesh in DPF is represented by the :class:`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 index e828fdee5e..79b4710f6d 100644 --- 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 ************************************* From be5197ca10723639581adc5a69a70c024264ab9b Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 12 Nov 2024 16:12:20 +0100 Subject: [PATCH 16/23] updates --- .../user_guide/tutorials/03-processing_basics/index.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/user_guide/tutorials/03-processing_basics/index.rst b/doc/source/user_guide/tutorials/03-processing_basics/index.rst index f7b70f287d..2d7eb6f329 100644 --- a/doc/source/user_guide/tutorials/03-processing_basics/index.rst +++ b/doc/source/user_guide/tutorials/03-processing_basics/index.rst @@ -39,4 +39,10 @@ If you are not familiarized with those concepts you can check our concepts secti 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. \ No newline at end of file + visualize and analyze simulation results. + +.. toctree:: + :maxdepth: 2 + :hidden: + + 01-main-steps.rst \ No newline at end of file From f5f8f88ff5de2a476e9a042e1aae923c13be2bea Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 12 Nov 2024 16:12:34 +0100 Subject: [PATCH 17/23] updates --- doc/source/user_guide/tutorials/01-data_structures/index.rst | 4 ++++ .../user_guide/tutorials/02-language_and_usage/index.rst | 2 -- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/tutorials/01-data_structures/index.rst b/doc/source/user_guide/tutorials/01-data_structures/index.rst index 4a4cd2d011..602efc732d 100644 --- a/doc/source/user_guide/tutorials/01-data_structures/index.rst +++ b/doc/source/user_guide/tutorials/01-data_structures/index.rst @@ -36,3 +36,7 @@ These tutorials explains how these structures work and how you can manipulate da This tutorial shows how to create and work with some DPF collections: FieldsContainer, MeshesContainer and ScopingContainer + +.. toctree:: + :maxdepth: 2 + :hidden: 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 index 543bdf7e3b..d56d10a795 100644 --- a/doc/source/user_guide/tutorials/02-language_and_usage/index.rst +++ b/doc/source/user_guide/tutorials/02-language_and_usage/index.rst @@ -8,5 +8,3 @@ 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`. - - From 823289fe94859b96351621dc262ed3796d44dbfa Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Wed, 13 Nov 2024 15:23:27 +0100 Subject: [PATCH 18/23] update tutorials main page --- doc/source/user_guide/index.rst | 26 +++++----- .../tutorials/03-processing_basics/index.rst | 48 ------------------- .../{09-animate => animate}/index.rst | 0 .../index.rst | 0 .../index.rst | 0 .../{12-dpf_server => dpf_server}/index.rst | 0 .../index.rst | 0 .../{07-export_data => export_data}/index.rst | 0 .../{04-import_data => import_data}/index.rst | 0 doc/source/user_guide/tutorials/index.rst | 7 ++- .../index.rst | 0 .../{13-licensing => licensing}/index.rst | 0 .../tutorials/{05-mesh => mesh}/index.rst | 0 .../tutorials/{08-plot => plot}/index.rst | 0 .../01-main-steps.rst | 0 .../post_processing_basics/index.rst | 14 ++++++ .../index.rst | 0 17 files changed, 32 insertions(+), 63 deletions(-) delete mode 100644 doc/source/user_guide/tutorials/03-processing_basics/index.rst rename doc/source/user_guide/tutorials/{09-animate => animate}/index.rst (100%) rename doc/source/user_guide/tutorials/{01-data_structures => data_structures}/index.rst (100%) rename doc/source/user_guide/tutorials/{11-distributed_files => distributed_files}/index.rst (100%) rename doc/source/user_guide/tutorials/{12-dpf_server => dpf_server}/index.rst (100%) rename doc/source/user_guide/tutorials/{10-enriching_dpf_capabilities => enriching_dpf_capabilities}/index.rst (100%) rename doc/source/user_guide/tutorials/{07-export_data => export_data}/index.rst (100%) rename doc/source/user_guide/tutorials/{04-import_data => import_data}/index.rst (100%) rename doc/source/user_guide/tutorials/{02-language_and_usage => language_and_usage}/index.rst (100%) rename doc/source/user_guide/tutorials/{13-licensing => licensing}/index.rst (100%) rename doc/source/user_guide/tutorials/{05-mesh => mesh}/index.rst (100%) rename doc/source/user_guide/tutorials/{08-plot => plot}/index.rst (100%) rename doc/source/user_guide/tutorials/{03-processing_basics => post_processing_basics}/01-main-steps.rst (100%) create mode 100644 doc/source/user_guide/tutorials/post_processing_basics/index.rst rename doc/source/user_guide/tutorials/{06-transform_data => transform_data}/index.rst (100%) diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 523bd82e0c..c6a71c3a91 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -57,19 +57,19 @@ Troubleshooting :hidden: :caption: Tutorials - 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 - tutorials/07-export_data/index.rst - tutorials/08-plot/index.rst - tutorials/09-animate/index.rst - tutorials/10-enriching_dpf_capabilities/index.rst - tutorials/11-distributed_files/index.rst - tutorials/12-dpf_server/index.rst - tutorials/13-licensing/index.rst + tutorials/data_structures/index.rst + tutorials/language_and_usage/index.rst + tutorials/post_processing_basics/index.rst + tutorials/import_data/index.rst + tutorials/mesh/index.rst + tutorials/transform_data/index.rst + tutorials/export_data/index.rst + tutorials/plot/index.rst + tutorials/animate/index.rst + tutorials/enriching_dpf_capabilities/index.rst + tutorials/distributed_files/index.rst + tutorials/dpf_server/index.rst + tutorials/licensing/index.rst .. toctree:: :maxdepth: 2 diff --git a/doc/source/user_guide/tutorials/03-processing_basics/index.rst b/doc/source/user_guide/tutorials/03-processing_basics/index.rst deleted file mode 100644 index 2d7eb6f329..0000000000 --- a/doc/source/user_guide/tutorials/03-processing_basics/index.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. _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. - -.. toctree:: - :maxdepth: 2 - :hidden: - - 01-main-steps.rst \ No newline at end of file diff --git a/doc/source/user_guide/tutorials/09-animate/index.rst b/doc/source/user_guide/tutorials/animate/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/09-animate/index.rst rename to doc/source/user_guide/tutorials/animate/index.rst diff --git a/doc/source/user_guide/tutorials/01-data_structures/index.rst b/doc/source/user_guide/tutorials/data_structures/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/01-data_structures/index.rst rename to doc/source/user_guide/tutorials/data_structures/index.rst diff --git a/doc/source/user_guide/tutorials/11-distributed_files/index.rst b/doc/source/user_guide/tutorials/distributed_files/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/11-distributed_files/index.rst rename to doc/source/user_guide/tutorials/distributed_files/index.rst diff --git a/doc/source/user_guide/tutorials/12-dpf_server/index.rst b/doc/source/user_guide/tutorials/dpf_server/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/12-dpf_server/index.rst rename to doc/source/user_guide/tutorials/dpf_server/index.rst diff --git a/doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst b/doc/source/user_guide/tutorials/enriching_dpf_capabilities/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/10-enriching_dpf_capabilities/index.rst rename to doc/source/user_guide/tutorials/enriching_dpf_capabilities/index.rst diff --git a/doc/source/user_guide/tutorials/07-export_data/index.rst b/doc/source/user_guide/tutorials/export_data/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/07-export_data/index.rst rename to doc/source/user_guide/tutorials/export_data/index.rst diff --git a/doc/source/user_guide/tutorials/04-import_data/index.rst b/doc/source/user_guide/tutorials/import_data/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/04-import_data/index.rst rename to doc/source/user_guide/tutorials/import_data/index.rst diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 79b4710f6d..9e34db9cfc 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -40,12 +40,15 @@ of our package background so you can understand how to work with it. Learn the different ways to interact with data by using PyDPF-Core objects and methods. - .. grid-item-card:: Processing data basics + .. grid-item-card:: Post-processing data basics :link: ref_tutorials_processing_basics :link-type: ref :text-align: center - Learn the basics on how data can be manipulated with PyDPF-Core + Learn the basics on a 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. :fa:`book-open-reader` Features usage ************************************* diff --git a/doc/source/user_guide/tutorials/02-language_and_usage/index.rst b/doc/source/user_guide/tutorials/language_and_usage/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/02-language_and_usage/index.rst rename to doc/source/user_guide/tutorials/language_and_usage/index.rst diff --git a/doc/source/user_guide/tutorials/13-licensing/index.rst b/doc/source/user_guide/tutorials/licensing/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/13-licensing/index.rst rename to doc/source/user_guide/tutorials/licensing/index.rst diff --git a/doc/source/user_guide/tutorials/05-mesh/index.rst b/doc/source/user_guide/tutorials/mesh/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/05-mesh/index.rst rename to doc/source/user_guide/tutorials/mesh/index.rst diff --git a/doc/source/user_guide/tutorials/08-plot/index.rst b/doc/source/user_guide/tutorials/plot/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/08-plot/index.rst rename to doc/source/user_guide/tutorials/plot/index.rst diff --git a/doc/source/user_guide/tutorials/03-processing_basics/01-main-steps.rst b/doc/source/user_guide/tutorials/post_processing_basics/01-main-steps.rst similarity index 100% rename from doc/source/user_guide/tutorials/03-processing_basics/01-main-steps.rst rename to doc/source/user_guide/tutorials/post_processing_basics/01-main-steps.rst diff --git a/doc/source/user_guide/tutorials/post_processing_basics/index.rst b/doc/source/user_guide/tutorials/post_processing_basics/index.rst new file mode 100644 index 0000000000..b98cf33a34 --- /dev/null +++ b/doc/source/user_guide/tutorials/post_processing_basics/index.rst @@ -0,0 +1,14 @@ +.. _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. + +The tutorials in this section presents a basic application of PyDPF-Core as post-processing tool. + +.. include:: 01-main-steps.rst \ No newline at end of file diff --git a/doc/source/user_guide/tutorials/06-transform_data/index.rst b/doc/source/user_guide/tutorials/transform_data/index.rst similarity index 100% rename from doc/source/user_guide/tutorials/06-transform_data/index.rst rename to doc/source/user_guide/tutorials/transform_data/index.rst From cdadc07628df1d207b6ab6e11423b3119e474a7b Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Wed, 13 Nov 2024 16:21:11 +0100 Subject: [PATCH 19/23] add maths section --- doc/source/user_guide/tutorials/index.rst | 17 +++++++++- .../tutorials/mathematics/index.rst | 32 +++++++++++++++++++ 2 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 doc/source/user_guide/tutorials/mathematics/index.rst diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 9e34db9cfc..1d857cecc3 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -126,4 +126,19 @@ of our package background so you can understand how to work with it. :link-type: ref :text-align: center - Understand how to access the Entry and Premium licensing capabilities \ No newline at end of file + Understand how to access the Entry and Premium licensing capabilities + + .. grid-item-card:: Mathematical operations + :link: ref_tutorials_mathematics + :link-type: ref + :text-align: center + + Learn how to do mathematical operations using PyDPF-Core API and data structures + + .. grid-item-card:: Manipulating physics data + :link: ref_tutorials_mathematics + :link-type: ref + :text-align: center + + Learn how to do manipulate the physics data associate to a + data storage structure. (Unit, homogeneity ...) \ No newline at end of file diff --git a/doc/source/user_guide/tutorials/mathematics/index.rst b/doc/source/user_guide/tutorials/mathematics/index.rst new file mode 100644 index 0000000000..b4c251b086 --- /dev/null +++ b/doc/source/user_guide/tutorials/mathematics/index.rst @@ -0,0 +1,32 @@ +.. _ref_tutorials_mathematics: + +=========== +Mathematics +=========== + +DPF provides operators for implementing mathematical operations, ranging +from addition and multiplication to FFT and QR solving. + +This section explains how to you can do mathematical operations using +PyDPF-Core API and data structures. + +.. grid:: 1 1 3 3 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Basic maths + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial demonstrate how to do some basic + mathematical operations with PyDPF-Core. + +.. toctree:: + :maxdepth: 2 + :hidden: + + + + From df79026995dc9becb4bca178d5c776c9cf705e77 Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Wed, 13 Nov 2024 16:23:03 +0100 Subject: [PATCH 20/23] add physics data section --- doc/source/user_guide/tutorials/index.rst | 2 +- .../manipulate_physics_data/index.rst | 24 +++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 doc/source/user_guide/tutorials/manipulate_physics_data/index.rst diff --git a/doc/source/user_guide/tutorials/index.rst b/doc/source/user_guide/tutorials/index.rst index 1d857cecc3..f982528585 100644 --- a/doc/source/user_guide/tutorials/index.rst +++ b/doc/source/user_guide/tutorials/index.rst @@ -140,5 +140,5 @@ of our package background so you can understand how to work with it. :link-type: ref :text-align: center - Learn how to do manipulate the physics data associate to a + Learn how to manipulate the physics data associate to a data storage structure. (Unit, homogeneity ...) \ No newline at end of file diff --git a/doc/source/user_guide/tutorials/manipulate_physics_data/index.rst b/doc/source/user_guide/tutorials/manipulate_physics_data/index.rst new file mode 100644 index 0000000000..31b4fd3665 --- /dev/null +++ b/doc/source/user_guide/tutorials/manipulate_physics_data/index.rst @@ -0,0 +1,24 @@ +.. _ref_tutorials_manipulate_physics_data: + +======================= +Manipulate Physics data +======================= + +This sections demonstrates how to manipulate the physics data associate to a +data storage structure. (Unit, homogeneity ...). + +.. grid:: 1 1 3 3 + :gutter: 2 + :padding: 2 + :margin: 2 + + .. grid-item-card:: Unit + :link: ref_tutorials + :link-type: ref + :text-align: center + + This tutorial + +.. toctree:: + :maxdepth: 2 + :hidden: From e081f8888a34ccd5f8c466de3290f8980d8a181a Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Thu, 7 Nov 2024 14:23:14 +0100 Subject: [PATCH 21/23] adapts the "server types" how to into a licensing tutorial --- .../user_guide/tutorials/dpf_server/index.rst | 2 ++ .../dpf_server}/server_types.rst | 36 +++++++++++-------- 2 files changed, 24 insertions(+), 14 deletions(-) rename doc/source/user_guide/{ => tutorials/dpf_server}/server_types.rst (91%) diff --git a/doc/source/user_guide/tutorials/dpf_server/index.rst b/doc/source/user_guide/tutorials/dpf_server/index.rst index efc4e1bfdb..d4b3b64806 100644 --- a/doc/source/user_guide/tutorials/dpf_server/index.rst +++ b/doc/source/user_guide/tutorials/dpf_server/index.rst @@ -22,3 +22,5 @@ This tutorial explains how to manipulate DPF client-server architecture :maxdepth: 2 :hidden: + server_types.rst + diff --git a/doc/source/user_guide/server_types.rst b/doc/source/user_guide/tutorials/dpf_server/server_types.rst similarity index 91% rename from doc/source/user_guide/server_types.rst rename to doc/source/user_guide/tutorials/dpf_server/server_types.rst index 8ee493a7bd..a72c0e3b82 100644 --- a/doc/source/user_guide/server_types.rst +++ b/doc/source/user_guide/tutorials/dpf_server/server_types.rst @@ -29,30 +29,33 @@ using the :class:`InProcess ` class .. rst-class:: sphx-glr-script-out - .. code-block:: none - - + .. jupyter-execute:: + :hide-code: + + from ansys.dpf import core as dpf + local_server = dpf.start_local_server() + local_server This DPF Server can now be used to instantiate models, operators, and more. .. code-block:: - + # instantiate an operator local_operator = dpf.operators.results.displacement(server=local_server) - + # instantiate a model from ansys.dpf.core import examples local_model = dpf.Model(examples.find_simple_bar(), server=local_server) - + DPF Server through the network using gRPC ----------------------------------------- The :class:`GrpcServer ` class is used -to enable gRPC communication: +to enable gRPC communication: .. code-block:: - + from ansys.dpf import core as dpf grpc_server_config = dpf.AvailableServerConfigs.GrpcServer grpc_server = dpf.start_local_server(config=grpc_server_config) @@ -60,21 +63,26 @@ to enable gRPC communication: .. rst-class:: sphx-glr-script-out - .. code-block:: none - - + .. jupyter-execute:: + :hide-code: + + from ansys.dpf import core as dpf + grpc_server_config = dpf.AvailableServerConfigs.GrpcServer + grpc_server = dpf.start_local_server(config=grpc_server_config) + grpc_server You can obtain the server port and IP address: .. code-block:: print(grpc_server) - + .. rst-class:: sphx-glr-script-out - .. code-block:: none + .. jupyter-execute:: + :hide-code: - DPF Server: {'server_ip': '127.0.0.1', 'server_port': 50052, 'server_process_id': 9999, 'server_version': '6.0', 'os': 'nt'} + print(grpc_server) From another machine, you can connect remotely to this DPF Server and instantiate models, operators, and more: From a186370bf7d7b9f401f5798722649d4fd7393ecd Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Tue, 12 Nov 2024 16:41:14 +0100 Subject: [PATCH 22/23] update dpf server index --- doc/source/user_guide/tutorials/dpf_server/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/tutorials/dpf_server/index.rst b/doc/source/user_guide/tutorials/dpf_server/index.rst index d4b3b64806..8031a9a19e 100644 --- a/doc/source/user_guide/tutorials/dpf_server/index.rst +++ b/doc/source/user_guide/tutorials/dpf_server/index.rst @@ -12,11 +12,11 @@ This tutorial explains how to manipulate DPF client-server architecture :margin: 2 .. grid-item-card:: Switch between local and remote server - :link: ref_tutorials + :link: user_guide_server_types :link-type: ref :text-align: center - This tutorial + explains how to manipulate DPF client-server architecture .. toctree:: :maxdepth: 2 From 9b9e26ec5d8a9396944928e43e7b7a578775635f Mon Sep 17 00:00:00 2001 From: luisaFelixSalles Date: Fri, 15 Nov 2024 16:10:36 +0100 Subject: [PATCH 23/23] update --- .../user_guide/tutorials/dpf_server/server_types.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/user_guide/tutorials/dpf_server/server_types.rst b/doc/source/user_guide/tutorials/dpf_server/server_types.rst index a72c0e3b82..8e1ebdc0b1 100644 --- a/doc/source/user_guide/tutorials/dpf_server/server_types.rst +++ b/doc/source/user_guide/tutorials/dpf_server/server_types.rst @@ -25,7 +25,7 @@ using the :class:`InProcess ` class from ansys.dpf import core as dpf local_server = dpf.start_local_server() - local_server + print(local_server) .. rst-class:: sphx-glr-script-out @@ -34,7 +34,7 @@ using the :class:`InProcess ` class from ansys.dpf import core as dpf local_server = dpf.start_local_server() - local_server + print(local_server) This DPF Server can now be used to instantiate models, operators, and more. @@ -59,7 +59,7 @@ to enable gRPC communication: from ansys.dpf import core as dpf grpc_server_config = dpf.AvailableServerConfigs.GrpcServer grpc_server = dpf.start_local_server(config=grpc_server_config) - grpc_server + print(grpc_server) .. rst-class:: sphx-glr-script-out @@ -69,7 +69,7 @@ to enable gRPC communication: from ansys.dpf import core as dpf grpc_server_config = dpf.AvailableServerConfigs.GrpcServer grpc_server = dpf.start_local_server(config=grpc_server_config) - grpc_server + print(grpc_server) You can obtain the server port and IP address: