diff --git a/docs/_static/images/E_PF.png b/docs/_static/images/E_PF.png new file mode 100644 index 0000000..066622e Binary files /dev/null and b/docs/_static/images/E_PF.png differ diff --git a/docs/_static/images/E_plot3D.png b/docs/_static/images/E_plot3D.png new file mode 100644 index 0000000..c4a4a84 Binary files /dev/null and b/docs/_static/images/E_plot3D.png differ diff --git a/docs/_static/images/E_xyz_sections.png b/docs/_static/images/E_xyz_sections.png new file mode 100644 index 0000000..756f459 Binary files /dev/null and b/docs/_static/images/E_xyz_sections.png differ diff --git a/docs/_static/images/G_plot3D.png b/docs/_static/images/G_plot3D.png new file mode 100644 index 0000000..1e442b2 Binary files /dev/null and b/docs/_static/images/G_plot3D.png differ diff --git a/docs/_static/images/G_plot3D_min.png b/docs/_static/images/G_plot3D_min.png new file mode 100644 index 0000000..6a5409b Binary files /dev/null and b/docs/_static/images/G_plot3D_min.png differ diff --git a/docs/_static/images/G_xyz_sections.png b/docs/_static/images/G_xyz_sections.png new file mode 100644 index 0000000..5e1a0ac Binary files /dev/null and b/docs/_static/images/G_xyz_sections.png differ diff --git a/docs/source/example_StiffnessTensor.rst b/docs/source/example_StiffnessTensor.rst index 0679cd1..c1d8f97 100644 --- a/docs/source/example_StiffnessTensor.rst +++ b/docs/source/example_StiffnessTensor.rst @@ -90,15 +90,24 @@ In order to fully evidence the directional dependence of the Young moduli, we ca >>> E.plot3D() # doctest: +SKIP + .. image:: ../_static/images/E_plot3D.png + :width: 400 + It is advised to use interactive plot to be able to zoom/rotate the surface. For flat images (i.e. to put in document/articles), we can use plot the values as a Pole Figure (PF): >>> E.plot_as_pole_figure() # doctest: +SKIP + .. image:: ../_static/images/E_PF.png + :width: 400 + Alternatively, we can plot the Young moduli on X-Y, X-Z and Y-Z sections only: >>> E.plot_xyz_sections() # doctest: +SKIP + .. image:: ../_static/images/E_xyz_sections.png + :width: 600 + Hyperspherical functions ~~~~~~~~~~~~~~~~~~~~~~~~ Hyperspherical functions cannot plotted as 3D surfaces, as their values depend on two orthogonal directions. @@ -107,12 +116,21 @@ plotting: >>> G.plot3D() # doctest: +SKIP + .. image:: ../_static/images/G_plot3D.png + :width: 400 + Instead of the mean value, we can consider other statistics, e.g.: >>> G.plot3D(which='min') # doctest: +SKIP + .. image:: ../_static/images/G_plot3D_min.png + :width: 400 + This also works for ``max`` and ``std``. These parameters also apply for pole figures (see above). When plotting the X-Y, X-Z and Y-Z sections, the min, max and mean values are plotted at once: - >>> G.plot_xyz_sections() # doctest: +SKIP \ No newline at end of file + >>> G.plot_xyz_sections() # doctest: +SKIP + + .. image:: ../_static/images/G_xyz_sections.png + :width: 600 \ No newline at end of file