From ea51f3ccd8bab76549a45c3577e2c9b83e1f0861 Mon Sep 17 00:00:00 2001 From: hannah Date: Mon, 17 Jul 2023 00:39:27 -0400 Subject: [PATCH] more consistent data structure oriented headers and explanations for plot types Co-authored-by: Oscar Gustafsson Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> --- doc/sphinxext/gallery_order.py | 2 +- galleries/plot_types/3D/README.rst | 7 ++++--- galleries/plot_types/README.rst | 5 ++--- galleries/plot_types/arrays/README.rst | 8 +++++--- galleries/plot_types/basic/README.rst | 7 ++++--- galleries/plot_types/stats/README.rst | 7 ++++--- galleries/plot_types/unstructured/README.rst | 10 ++++------ 7 files changed, 24 insertions(+), 22 deletions(-) diff --git a/doc/sphinxext/gallery_order.py b/doc/sphinxext/gallery_order.py index 02050e714d7d..70a018750537 100644 --- a/doc/sphinxext/gallery_order.py +++ b/doc/sphinxext/gallery_order.py @@ -38,8 +38,8 @@ plot_types_order = [ '../galleries/plot_types/basic', - '../galleries/plot_types/arrays', '../galleries/plot_types/stats', + '../galleries/plot_types/arrays', '../galleries/plot_types/unstructured', '../galleries/plot_types/3D', UNSORTED diff --git a/galleries/plot_types/3D/README.rst b/galleries/plot_types/3D/README.rst index e7157d4ba628..61b2729dfb8f 100644 --- a/galleries/plot_types/3D/README.rst +++ b/galleries/plot_types/3D/README.rst @@ -1,6 +1,7 @@ .. _3D_plots: -3D --- +3D and volumetric data +---------------------- -3D plots using the `mpl_toolkits.mplot3d` library. +Plots of three-dimensional :math:`(x,y,z)`, surface :math:`f(x,y)=z`, and +volumetric :math:`V_{x, y, z}` data using the `mpl_toolkits.mplot3d` library. diff --git a/galleries/plot_types/README.rst b/galleries/plot_types/README.rst index ef5b08fbedbe..0bcbb3b804d7 100644 --- a/galleries/plot_types/README.rst +++ b/galleries/plot_types/README.rst @@ -5,8 +5,7 @@ Plot types ========== -Overview of many common plotting commands in Matplotlib. +Overview of many common plotting commands provided by Matplotlib. -Note that we have stripped all labels, but they are present by default. -See the `gallery <../gallery/index.html>`_ for many more examples and +See the `gallery <../gallery/index.html>`_ for more examples and the `tutorials page <../tutorials/index.html>`_ for longer examples. diff --git a/galleries/plot_types/arrays/README.rst b/galleries/plot_types/arrays/README.rst index 43844ee9490c..d9dbfd10ead7 100644 --- a/galleries/plot_types/arrays/README.rst +++ b/galleries/plot_types/arrays/README.rst @@ -1,6 +1,8 @@ .. _array_plots: -Plots of arrays and fields --------------------------- +Gridded data: +------------- -Plotting for arrays of data ``Z(x, y)`` and fields ``U(x, y), V(x, y)``. +Plots of arrays and images :math:`Z_{i, j}` and fields :math:`U_{i, j}, V_{i, j}` +on `regular grids `_ and +corresponding coordinate grids :math:`X_{i,j}, Y_{i,j}`. diff --git a/galleries/plot_types/basic/README.rst b/galleries/plot_types/basic/README.rst index 9ce35d083177..937c7484c8db 100644 --- a/galleries/plot_types/basic/README.rst +++ b/galleries/plot_types/basic/README.rst @@ -1,6 +1,7 @@ .. _basic_plots: -Basic ------ +Pairwise data +------------- -Basic plot types, usually y versus x. +Plots of pairwise :math:`(x, y)`, tabular :math:`(var\_0, \cdots, var\_n)`, +and functional :math:`f(x)=y` data. diff --git a/galleries/plot_types/stats/README.rst b/galleries/plot_types/stats/README.rst index b2ca855aafbc..56a56cb2db04 100644 --- a/galleries/plot_types/stats/README.rst +++ b/galleries/plot_types/stats/README.rst @@ -1,6 +1,7 @@ .. _stats_plots: -Statistics plots ----------------- +Statistical distributions +------------------------- -Plots for statistical analysis. +Plots of the distribution of at least one variable in a dataset. Some of these +methods also compute the distributions. diff --git a/galleries/plot_types/unstructured/README.rst b/galleries/plot_types/unstructured/README.rst index 89b7844775d2..89b7924dd2f4 100644 --- a/galleries/plot_types/unstructured/README.rst +++ b/galleries/plot_types/unstructured/README.rst @@ -1,9 +1,7 @@ .. _unstructured_plots: -Unstructured coordinates -------------------------- +Irregularly gridded data +------------------------ -Sometimes we collect data ``z`` at coordinates ``(x,y)`` and want to visualize -as a contour. Instead of gridding the data and then using -`~.axes.Axes.contour`, we can use a triangulation algorithm and fill the -triangles. +Plots of data :math:`Z_{x, y}` on `unstructured grids `_ , +unstructured coordinate grids :math:`(x, y)`, and 2D functions :math:`f(x, y) = z`.