New tutorials section

doc/source/conf.py

@@ -87,6 +87,7 @@
     "sphinx_design",
     "sphinx_gallery.gen_gallery",
     'sphinx_reredirects',
+    "jupyter_sphinx",
 ]
 
 redirects = {

doc/source/user_guide/index.rst

@@ -4,24 +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::
-   main_entities.rst
+   tutorials/index.rst
 
 .. include::
-   how_to.rst
-
+   concepts/index.rst
 
 Troubleshooting
 ---------------
@@ -52,6 +52,25 @@ Troubleshooting
        :text-align: center
 
 
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+    :caption: Tutorials
+
+    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
    :hidden:
@@ -61,30 +80,6 @@ Troubleshooting
    concepts/waysofusing.rst
    concepts/stepbystep.rst
 
-
-.. toctree::
-    :maxdepth: 2
-    :hidden:
-    :caption: DPF most-used entities
-
-    model
-    operators
-    fields_container
-
-
-.. toctree::
-    :maxdepth: 2
-    :hidden:
-    :caption: How-tos
-
-    plotting.rst
-    custom_operators.rst
-    dpf_server.rst
-    server_types.rst
-    server_context.rst
-    xmlfiles.rst
-
-
 .. toctree::
     :maxdepth: 3
     :hidden:

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

@@ -0,0 +1,24 @@
+.. _ref_tutorials_animate:
+
+=======
+Animate
+=======
+
+These tutorials demonstrate how to visualise the data in an animation.
+
+.. grid:: 1 1 3 3
+    :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:
+

doc/source/user_guide/tutorials/data_structures/index.rst

@@ -0,0 +1,42 @@
+.. _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
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:

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

@@ -0,0 +1,31 @@
+.. _ref_tutorials_distributed_files:
+
+==============================
+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
+    :margin: 2
+
+    .. 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:
+

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

@@ -0,0 +1,24 @@
+.. _ref_tutorials_dpf_server:
+
+==========
+DPF server
+==========
+
+This tutorial explains how to manipulate DPF client-server architecture
+
+.. grid:: 1 1 3 3
+    :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:
+

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

@@ -0,0 +1,42 @@
+.. _ref_tutorials_enriching:
+
+==========================
+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
+    :margin: 2
+
+    .. grid-item-card:: Create custom operators and plugins
+       :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:
+

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

@@ -0,0 +1,28 @@
+.. _ref_tutorials_export_data:
+
+===========
+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 <https://numpy.org/>`_ and `matplotlib <https://matplotlib.org/>`_ 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:: HDF5 export
+       :link: ref_tutorials
+       :link-type: ref
+       :text-align: center
+
+       This tutorial
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+

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

@@ -0,0 +1,65 @@
+.. _ref_tutorials_import_data:
+
+===========
+Import Data
+===========
+
+These tutorials demonstrate how to represent data in DPF: either from manual input either
+form simulation result files.
+
+From user input
+***************
+
+.. grid:: 1 1 3 3
+    :gutter: 2
+    :padding: 2
+    :margin: 2
+
+    .. grid-item-card:: Import data from csv file
+       :link: ref_tutorials
+       :link-type: ref
+       :text-align: center
+
+       Learn how to import data in DPF from csv file
+
+    .. grid-item-card:: Represent your data in DPF
+       :link: ref_tutorials
+       :link-type: ref
+       :text-align: center
+
+       Learn how to represent your manual input data in a DPF data storage structure
+
+From result files
+*****************
+
+.. grid:: 1 1 3 3
+    :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:
+