Removing references to open3d in the documentation.

LyceanEM · May 29, 2024 · 2c00f3a · 2c00f3a
1 parent cfa742e
commit 2c00f3a
Show file tree

Hide file tree

Showing 19 changed files with 47 additions and 1,351 deletions.
diff --git a/docs/source/auto_examples/01_aperture_projection.ipynb b/docs/source/auto_examples/01_aperture_projection.ipynb
@@ -51,7 +51,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Geometries\nIn order to make things easy to start, an example geometry has been included within LyceanEM for a UAV, and the\nopen3d trianglemesh structures can be accessed by importing the data subpackage\n\n"
+        "## Geometries\nIn order to make things easy to start, an example geometry has been included within LyceanEM for a UAV, and the\nmeshio trianglemesh structures can be accessed by importing the data subpackage\n\n"
       ]
     },
     {
@@ -87,7 +87,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Structures\nLyceanEM uses a class named 'structures' to store and maniuplate joined 3D solids. Currently all that is implemented\nis the class itself, and methods to allow translation and rotation of the trianglemesh solids. A structure can be\npassed to the models to provide the environment to be considered as blockers.\nstructures are created by calling the class, and passing it a list of the open3d trianglemesh structures to be added.\n\n"
+        "## Structures\nLyceanEM uses a class named 'structures' to store and maniuplate joined 3D solids. Currently all that is implemented\nis the class itself, and methods to allow translation and rotation of the trianglemesh solids. A structure can be\npassed to the models to provide the environment to be considered as blockers.\nstructures are created by calling the class, and passing it a list of the meshio trianglemesh structures to be added.\n\n"
       ]
     },
     {
@@ -105,7 +105,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Aperture Projection\nAperture Projection is imported from the frequency domain models, requiring the aperture of interest, wavelength to\nbe considered, and the azimuth and elevation ranges. The function then returns the directivity envelope as a numpy\narray of floats, and an open3d point cloud with points and colors corresponding to the directivity envelope of the\nprovided aperture, scaling from yellow at maximum to dark purple at minimum.\n\n"
+        "## Aperture Projection\nAperture Projection is imported from the frequency domain models, requiring the aperture of interest, wavelength to\nbe considered, and the azimuth and elevation ranges. The function then returns the directivity envelope as a numpy\narray of floats, and a meshio point cloud with points and colors corresponding to the directivity envelope of the\nprovided aperture, scaling from yellow at maximum to dark purple at minimum.\n\n"
       ]
     },
     {
@@ -123,7 +123,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Open3D Visualisation\nThe resultant maximum directivity envelope is provided as both a numpy array of directivities for each angle, but\nalso as an open3d point cloud. This allows easy visualisation using :func:`open3d.visualization.draw_geometries`.\n%%\n\n"
+        "## Visualisation\nThe resultant maximum directivity envelope is provided as both a numpy array of directivities for each angle, but\nalso as an meshio point cloud. This allows easy visualisation using pyvista.\n%%\n\n"
       ]
     },
     {
@@ -148,7 +148,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Plotting the Output\nWhile the open3d visualisation is very intuitive for examining the results of the aperture projection, it is\ndifficult to consider the full 3D space, and cannot be included in documentation in this form. However, matplotlib\ncan be used to generate contour plots with 3dB contours to give a more systematic understanding of the resultant\nmaximum directivity envelope.\n\n"
+        "## Plotting the Output\nWhile the pyvista visualisation is very intuitive for examining the results of the aperture projection, it is\ndifficult to consider the full 3D space, and cannot be included in documentation in this form. However, matplotlib\ncan be used to generate contour plots with 3dB contours to give a more systematic understanding of the resultant\nmaximum directivity envelope.\n\n"
       ]
     },
     {

diff --git a/docs/source/auto_examples/01_aperture_projection.py b/docs/source/auto_examples/01_aperture_projection.py
@@ -48,7 +48,7 @@
 # Geometries
 # ------------------------
 # In order to make things easy to start, an example geometry has been included within LyceanEM for a UAV, and the
-# open3d trianglemesh structures can be accessed by importing the data subpackage
+# meshio trianglemesh structures can be accessed by importing the data subpackage
 import lyceanem.tests.reflectordata as data
 
 body, array, _ = data.exampleUAV(10e9)
@@ -71,7 +71,7 @@
 # LyceanEM uses a class named 'structures' to store and maniuplate joined 3D solids. Currently all that is implemented
 # is the class itself, and methods to allow translation and rotation of the trianglemesh solids. A structure can be
 # passed to the models to provide the environment to be considered as blockers.
-# structures are created by calling the class, and passing it a list of the open3d trianglemesh structures to be added.
+# structures are created by calling the class, and passing it a list of the meshio trianglemesh structures to be added.
 from lyceanem.base_classes import structures
 
 blockers = structures([body])
@@ -81,7 +81,7 @@
 # -----------------------
 # Aperture Projection is imported from the frequency domain models, requiring the aperture of interest, wavelength to
 # be considered, and the azimuth and elevation ranges. The function then returns the directivity envelope as a numpy
-# array of floats, and an open3d point cloud with points and colors corresponding to the directivity envelope of the
+# array of floats, and a meshio point cloud with points and colors corresponding to the directivity envelope of the
 # provided aperture, scaling from yellow at maximum to dark purple at minimum.
 from lyceanem.models.frequency_domain import aperture_projection
 
@@ -93,10 +93,10 @@
     elev_range=np.linspace(-90.0, 90.0, elev_res),
 )
 # %%
-# Open3D Visualisation
+# Visualisation
 # ------------------------
 # The resultant maximum directivity envelope is provided as both a numpy array of directivities for each angle, but
-# also as an open3d point cloud. This allows easy visualisation using :func:`open3d.visualization.draw_geometries`.
+# also as an meshio point cloud. This allows easy visualisation using pyvista.
 # %%
 
 
@@ -114,7 +114,7 @@
 # %%
 # Plotting the Output
 # ------------------------
-# While the open3d visualisation is very intuitive for examining the results of the aperture projection, it is
+# While the pyvista visualisation is very intuitive for examining the results of the aperture projection, it is
 # difficult to consider the full 3D space, and cannot be included in documentation in this form. However, matplotlib
 # can be used to generate contour plots with 3dB contours to give a more systematic understanding of the resultant
 # maximum directivity envelope.

diff --git a/docs/source/auto_examples/01_aperture_projection.rst b/docs/source/auto_examples/01_aperture_projection.rst
@@ -49,12 +49,6 @@ be predicted using the :func:`lyceanem.models.frequency_domain.aperture_projecti
     import numpy as np
 
 
-
-
-
-
-
-
 .. GENERATED FROM PYTHON SOURCE LINES 33-42
 
 Setting Farfield Resolution and Wavelength
@@ -77,18 +71,12 @@ an X band aperture.
     wavelength = 3e8 / 10e9
 
 
-
-
-
-
-
-
 .. GENERATED FROM PYTHON SOURCE LINES 48-52
 
 Geometries
 ------------------------
 In order to make things easy to start, an example geometry has been included within LyceanEM for a UAV, and the
-open3d trianglemesh structures can be accessed by importing the data subpackage
+meshio trianglemesh structures can be accessed by importing the data subpackage
 
 .. GENERATED FROM PYTHON SOURCE LINES 52-58
 
@@ -101,12 +89,6 @@ open3d trianglemesh structures can be accessed by importing the data subpackage
 
 
 
-
-
-
-
-
-
 .. GENERATED FROM PYTHON SOURCE LINES 59-60
 
 # .. image:: ../_static/open3d_structure.png
@@ -124,20 +106,14 @@ open3d trianglemesh structures can be accessed by importing the data subpackage
     surface_array.cell_data["Normals"] = np.array(array.cell_data["Normals"])[: (array.cells[0].data).shape[0] // 2]
 
 
-
-
-
-
-
-
 .. GENERATED FROM PYTHON SOURCE LINES 69-75
 
 Structures
 --------------
 LyceanEM uses a class named 'structures' to store and maniuplate joined 3D solids. Currently all that is implemented
 is the class itself, and methods to allow translation and rotation of the trianglemesh solids. A structure can be
 passed to the models to provide the environment to be considered as blockers.
-structures are created by calling the class, and passing it a list of the open3d trianglemesh structures to be added.
+structures are created by calling the class, and passing it a list of the meshio trianglemesh structures to be added.
 
 .. GENERATED FROM PYTHON SOURCE LINES 75-79
 
@@ -148,19 +124,13 @@ structures are created by calling the class, and passing it a list of the open3d
     blockers = structures([body])
 
 
-
-
-
-
-
-
 .. GENERATED FROM PYTHON SOURCE LINES 80-86
 
 Aperture Projection
 -----------------------
 Aperture Projection is imported from the frequency domain models, requiring the aperture of interest, wavelength to
 be considered, and the azimuth and elevation ranges. The function then returns the directivity envelope as a numpy
-array of floats, and an open3d point cloud with points and colors corresponding to the directivity envelope of the
+array of floats, and a meshio point cloud with points and colors corresponding to the directivity envelope of the
 provided aperture, scaling from yellow at maximum to dark purple at minimum.
 
 .. GENERATED FROM PYTHON SOURCE LINES 86-95
@@ -177,26 +147,12 @@ provided aperture, scaling from yellow at maximum to dark purple at minimum.
         elev_range=np.linspace(-90.0, 90.0, elev_res),
     )
 
-
-
-
-.. rst-class:: sphx-glr-script-out
-
- .. code-block:: none
-
-    sources shape (1453, 3)
-    sinks shape (1369, 3)
-    environment_points shape (0, 3)
-
-
-
-
 .. GENERATED FROM PYTHON SOURCE LINES 96-101
 
-Open3D Visualisation
+Visualisation
 ------------------------
 The resultant maximum directivity envelope is provided as both a numpy array of directivities for each angle, but
-also as an open3d point cloud. This allows easy visualisation using :func:`open3d.visualization.draw_geometries`.
+also as an meshio point cloud. This allows easy visualisation using pyvista.
 %%
 
 .. GENERATED FROM PYTHON SOURCE LINES 104-105
@@ -217,23 +173,11 @@ also as an open3d point cloud. This allows easy visualisation using :func:`open3
     )
 
 
-
-
-
-.. rst-class:: sphx-glr-script-out
-
- .. code-block:: none
-
-    Maximum Directivity of 18.5 dBi
-
-
-
-
 .. GENERATED FROM PYTHON SOURCE LINES 115-121
 
 Plotting the Output
 ------------------------
-While the open3d visualisation is very intuitive for examining the results of the aperture projection, it is
+While the pyvista visualisation is very intuitive for examining the results of the aperture projection, it is
 difficult to consider the full 3D space, and cannot be included in documentation in this form. However, matplotlib
 can be used to generate contour plots with 3dB contours to give a more systematic understanding of the resultant
 maximum directivity envelope.
@@ -290,22 +234,6 @@ maximum directivity envelope.
     fig.show()
 
 
-
-.. image-sg:: /auto_examples/images/sphx_glr_01_aperture_projection_001.png
-   :alt: Maximum Directivity Envelope
-   :srcset: /auto_examples/images/sphx_glr_01_aperture_projection_001.png
-   :class: sphx-glr-single-img
-
-
-
-
-
-
-.. rst-class:: sphx-glr-timing
-
-   **Total running time of the script:** (0 minutes 17.869 seconds)
-
-
 .. _sphx_glr_download_auto_examples_01_aperture_projection.py:
 
 .. only:: html

diff --git a/docs/source/auto_examples/01_aperture_projection_codeobj.pickle b/docs/source/auto_examples/01_aperture_projection_codeobj.pickle
diff --git a/docs/source/auto_examples/02_coherently_polarised_array.ipynb b/docs/source/auto_examples/02_coherently_polarised_array.ipynb
@@ -51,7 +51,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "## Geometries\nIn order to make things easy to start, an example geometry has been included within LyceanEM for a UAV, and the\n:class:`open3d.geometry.TriangleMesh` structures can be accessed by importing the data subpackage\n\n"
+        "## Geometries\nIn order to make things easy to start, an example geometry has been included within LyceanEM for a UAV, and the\ntriangle structures can be accessed by importing the data subpackage\n\n"
       ]
     },
     {

diff --git a/docs/source/auto_examples/02_coherently_polarised_array.py b/docs/source/auto_examples/02_coherently_polarised_array.py
@@ -33,7 +33,7 @@
 # Geometries
 # ------------------------
 # In order to make things easy to start, an example geometry has been included within LyceanEM for a UAV, and the
-# :class:`open3d.geometry.TriangleMesh` structures can be accessed by importing the data subpackage
+# triangle structures can be accessed by importing the data subpackage
 import lyceanem.tests.reflectordata as data
 
 body, array, source_coords = data.exampleUAV(10e9)