Skip to content

Add plotting tutorials to the main tutorials branch #1903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
73c9412
add new basic tutorial and jupyter_ sphinx extension
luisaFelixSalles Oct 22, 2024
63cad96
add "plotting meshes" example
luisaFelixSalles Nov 13, 2024
a123130
add files for the others examples
luisaFelixSalles Nov 13, 2024
7329a32
update index page for plotting tuts
luisaFelixSalles Nov 13, 2024
9dc8eaf
add "plotting data on the meshe" example
luisaFelixSalles Nov 13, 2024
e80136f
update "plotting data on the meshe" example
luisaFelixSalles Nov 14, 2024
1bc25f2
updates
luisaFelixSalles Nov 14, 2024
03c96f4
updates on the index page of the plotting section
luisaFelixSalles Nov 14, 2024
8ea0102
updates
luisaFelixSalles Nov 15, 2024
d6254f1
add plotting_data_on_specific_placements.rst tut
luisaFelixSalles Nov 15, 2024
120b858
updates
luisaFelixSalles Nov 15, 2024
4cf090a
add plotting_a_graph.rst tut
luisaFelixSalles Nov 15, 2024
23665c5
updates
luisaFelixSalles Nov 15, 2024
f89405f
add plot meshes container in plotting_meshes.rst tutorial
luisaFelixSalles Nov 15, 2024
2a99022
add plot meshes container in plotting_meshes.rst tutorial update
luisaFelixSalles Nov 15, 2024
907c32d
add plotting_data_on_deformed_mesh.rst tutorial
luisaFelixSalles Nov 15, 2024
6a36fbd
updates
luisaFelixSalles Nov 15, 2024
a2b474b
erase the adapted examples
luisaFelixSalles Nov 15, 2024
e98dc3d
add separate plotting_data_on_geometry_elements.rst and plotting_data…
luisaFelixSalles Nov 18, 2024
0d0a6ab
update substitution text
luisaFelixSalles Nov 20, 2024
5c6b9c5
use only the jupyter sphinx extension
luisaFelixSalles Nov 22, 2024
2295ee2
updates the examples package references
luisaFelixSalles Nov 22, 2024
bec041e
update the plotting_meshes.rst to the tutorials guidelines
luisaFelixSalles Dec 19, 2024
0aff9a8
update the text of the plotting_meshes.rst to the tutorial
luisaFelixSalles Dec 20, 2024
56fa451
update the plotting_data_on_the_mesh.rst to the tutorials guidelines
luisaFelixSalles Dec 20, 2024
80888bb
update the text of the plotting_meshes.rst tutorial
luisaFelixSalles Dec 20, 2024
75c94d1
updates the text of the plotting_data_on_the_mesh.rst tutorial
luisaFelixSalles Dec 20, 2024
46d0970
updates the text of the plotting_data_on_the_mesh.rst tutorial
luisaFelixSalles Dec 20, 2024
5dd91d9
add the plotting_deformed_meshes.rst tutorial
luisaFelixSalles Dec 23, 2024
6a1b4ca
update the plotting_data_on_the_mesh.rst to the tutorials guidelines
luisaFelixSalles Dec 23, 2024
0329518
update the plotting_meshes.rst to the tutorials guidelines
luisaFelixSalles Dec 23, 2024
2dee2e4
update the plotting_data_on_specific_path.rst to the tutorials guidel…
luisaFelixSalles Dec 23, 2024
becbaa5
update the plotting_data_on_deformed_mesh.rst to the tutorials guidel…
luisaFelixSalles Dec 23, 2024
7189c8f
update the plotting_data_on_geometry_elements.rst to the tutorials gu…
luisaFelixSalles Dec 24, 2024
b0ba1d6
update the plotting_a_graph.rst to the tutorials guidelines
luisaFelixSalles Dec 24, 2024
9dcec80
add new links and substitution text to the links_and_refs.rst file
luisaFelixSalles Dec 24, 2024
ac5a0e8
update the card of the plotting a graph tutorial in the index.rst page
luisaFelixSalles Dec 24, 2024
185bd3f
delete file basic_tutorial.rst
luisaFelixSalles Dec 24, 2024
e690c15
Revert "erase the adapted examples"
luisaFelixSalles Dec 24, 2024
1e92e95
Apply suggestions from code review
luisaFelixSalles Jan 8, 2025
937745f
updates the files names, references and titles
luisaFelixSalles Jan 8, 2025
7b27bea
updates the download buttons
luisaFelixSalles Jan 8, 2025
a303f3c
updates the text of the plot_mesh.rst tutorial
luisaFelixSalles Jan 8, 2025
41eea94
updates the text of the plot_deformed_mesh.rst tutorial
luisaFelixSalles Jan 8, 2025
c498986
updates the text of the plot_data_on_a_mesh.rst tutorial
luisaFelixSalles Jan 8, 2025
f7613bf
updates the text of the plot_data_on_custom_geometry.rst tutorial
luisaFelixSalles Jan 8, 2025
27050fd
updates the text of the plot_data_on_custom_path.rst tutorial
luisaFelixSalles Jan 8, 2025
9ae5c0a
Merge branch 'doc/new-tutorials-section' into tutorials/plot/firsts-p…
PProfizi May 13, 2025
42a58eb
Merge branch 'doc/new-tutorials-section' into tutorials/plot/firsts-p…
PProfizi May 14, 2025
a13d0f6
Changes to tutorials/plot/index.rst
PProfizi May 15, 2025
de058e5
Changes to tutorials/plot/index.rst
PProfizi May 15, 2025
31bb36d
Reword transform data tutorials
PProfizi May 15, 2025
2109861
Merge remote-tracking branch 'origin/tutorials/plot/firsts-plotting-t…
PProfizi May 15, 2025
62fd48a
Rework plot_a_graph.rst
PProfizi May 15, 2025
847fe1c
Fix create_a_mesh_from_scratch.rst
PProfizi May 15, 2025
ed27c40
Finish plot_a_graph.rst
PProfizi May 16, 2025
0e0d672
Update plot_mesh.rst
PProfizi May 19, 2025
6a3f17b
Update plot_mesh.rst switch example file
PProfizi May 19, 2025
4ea5383
Update mesh plot tutorials
PProfizi May 19, 2025
e7e0902
Fix reference to plot_data_on_a_mesh.rst
PProfizi May 19, 2025
d720d11
Refactor plot tutorials list -> one tutorial for contours, one for de…
PProfizi May 19, 2025
581431f
Refactor plot tutorials list -> one tutorial for contours, one for de…
PProfizi May 19, 2025
6200aae
Rework plot_mesh.rst, plot_deformed_mesh.rst, and plot_contour.rst
PProfizi May 20, 2025
3f63bae
Merge remote-tracking branch 'origin/tutorials/plot/firsts-plotting-t…
PProfizi May 20, 2025
0d8aae0
Fixes to links in plot_a_graph.rst
PProfizi May 20, 2025
c5bf7d5
Remove plot_data_on_custom_path.rst from plot tutorials (it is a mapp…
PProfizi May 20, 2025
e1db276
Remove plot_data_on_custom_geometry.rst from plot tutorials (it is a …
PProfizi May 20, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/source/links_and_refs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@

.. Other libraries repos
.. _pyvista_github : https://github.com/pyvista/pyvista
.. _matplotlib_github : https://github.com/matplotlib/matplotlib

.. External links
.. _sphinx: https://www.sphinx-doc.org/en/master/
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Troubleshooting
tutorials/post_processing_basics/index.rst
tutorials/import_data/index.rst
tutorials/mesh/index.rst
tutorials/transform_data/index.rst
tutorials/operators_and_workflows/index.rst
tutorials/export_data/index.rst
tutorials/plot/index.rst
tutorials/animate/index.rst
Expand Down
42 changes: 21 additions & 21 deletions doc/source/user_guide/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ of our package background so you can understand how to work with it.
transform simulation data into output data that can be used to
visualize and analyze simulation results.

:fa:`book-open-reader` Features usage
*************************************
:fa:`book-open-reader` Common topics
************************************

.. grid:: 1 1 3 3
:gutter: 2
Expand All @@ -72,12 +72,12 @@ of our package background so you can understand how to work with it.

Learn how to explore a mesh in DPF.

.. grid-item-card:: Transform data with PyDPF-Core
:link: ref_tutorials_transform_data
.. grid-item-card:: Manipulate data with operators and workflows
:link: ref_tutorials_operators_and_workflows
:link-type: ref
:text-align: center

Learn how to transform and operate on data to obtain the desired input.
Learn how to use operators to process your data and build workflows.

.. grid-item-card:: Export data from DPF
:link: ref_tutorials_export_data
Expand All @@ -100,6 +100,21 @@ of our package background so you can understand how to work with it.

Explore the different approaches to visualise the data in an animation.

.. grid-item-card:: Mathematical operations
:link: ref_tutorials_mathematics
:link-type: ref
:text-align: center

Learn how to do mathematical operations using PyDPF-Core and data structures

.. grid-item-card:: Manipulating physics data
:link: ref_tutorials_manipulate_physics_data
:link-type: ref
:text-align: center

Learn how to manipulate the physics data associate to a
data storage structure. (Unit, homogeneity ...)

.. grid-item-card:: Enriching DPF capabilities
:link: ref_tutorials_enriching
:link-type: ref
Expand All @@ -126,19 +141,4 @@ 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

.. 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_manipulate_physics_data
:link-type: ref
:text-align: center

Learn how to manipulate the physics data associate to a
data storage structure. (Unit, homogeneity ...)
Understand how to access the Entry and Premium licensing capabilities
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Here, we create a function that will find this connectivity.

def search_sequence_numpy(arr, node):
"""Find the node location in an array of nodes and return its index."""
indexes = np.isclose(arr, seq)
indexes = np.isclose(arr, node)
match = np.all(indexes, axis=1).nonzero()
return int(match[0][0])

Expand Down
41 changes: 41 additions & 0 deletions doc/source/user_guide/tutorials/operators_and_workflows/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. _ref_tutorials_operators_and_workflows:

=========================================
Process data with operators and workflows
=========================================

An operator is the main object used to create, transform, and stream data in DPF.

They can perform different modifications of the data: direct mathematical operations,
averaging on the mesh, changes in the model locations.... They can also be chained together
to create workflows for more complex operations and customizable results.

The tutorials in this section present how to create and use these operators and workflows in 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
:margin: 2

.. grid-item-card:: Use operators
:link: ref_tutorials
:link-type: ref
:text-align: center

This tutorial

.. grid-item-card:: Create workflows
:link: ref_tutorials
:link-type: ref
:text-align: center

This tutorial

.. toctree::
:maxdepth: 2
:hidden:

31 changes: 18 additions & 13 deletions doc/source/user_guide/tutorials/plot/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,46 @@
Plot
====

These tutorials demonstrate some different approaches to visualise the data in plots.
These tutorials demonstrate different ways one can visualize the data in plots using PyDPF-Core.

.. grid:: 1 1 3 3
:gutter: 2
:padding: 2
:margin: 2

.. grid-item-card:: Plotting meshes
:link: ref_tutorials
.. grid-item-card:: Plot a mesh
:link: ref_tutorials_plot_mesh
:link-type: ref
:text-align: center

This tutorial
This tutorial shows several ways to plot meshes.

.. grid-item-card:: Plotting data on the mesh
:link: ref_tutorials
.. grid-item-card:: Add deformation
:link: ref_tutorials_plot_deformed_mesh
:link-type: ref
:text-align: center

This tutorial
This tutorial shows how to add deformation to plots.

.. grid-item-card:: Plotting data on specific placements
:link: ref_tutorials
.. grid-item-card:: Plot contours
:link: ref_tutorials_plot_contour
:link-type: ref
:text-align: center

This tutorial
This tutorial shows how to plot contours.

.. grid-item-card:: Plotting a graph
:link: ref_tutorials
.. grid-item-card:: Plot a graph
:link: ref_tutorials_plot_graph
:link-type: ref
:text-align: center

This tutorial
This tutorial shows how to plot graphs using matplotlib.

.. toctree::
:maxdepth: 2
:hidden:

plot_mesh.rst
plot_deformed_mesh.rst
plot_contour.rst
plot_a_graph.rst
Loading
Loading