improving docstrings for Point-, Cell-, and IndexedDataArrays

CHANGELOG.md

@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Helpful error message if `val` supplied to `SimulationData.plot_field` not supported.
 - Fixed validator that warns if angled plane wave does not match simulation boundaries, which was not warning for periodic boundaries.
 - Validates that no nans are present in `DataArray` values in custom components.
+- Removed nans from Cartesian temperature monitors in thermal simulations.
 
 ## [2.6.0rc1] - 2024-01-11
 

tidy3d/components/data/data_array.py

@@ -665,36 +665,52 @@ class ChargeDataArray(DataArray):
 
 
 class PointDataArray(DataArray):
-    """Indexed data array.
+    """A two-dimensional array that stores coordinates of a collection of points.
+    Dimension ``index`` denotes the index of a point in the collection, and dimension ``axis``
+    denotes the point's coordinate along that axis.
 
     Example
     -------
     >>> point_array = PointDataArray(
     ...     (1+1j) * np.random.random((5, 3)), coords=dict(index=np.arange(5), axis=np.arange(3)),
     ... )
+    >>> # get coordinates of a point number 3
+    >>> point3 = point_array.sel(index=3)
+    >>> # get x coordinates of all points
+    >>> x_coords = point_array.sel(axis=0)
     """
 
     __slots__ = ()
     _dims = ("index", "axis")
 
 
 class CellDataArray(DataArray):
-    """Cell connection data array.
+    """A two-dimensional array that stores indices of points composing each cell in a collection of
+    cells of the same type (for example: triangles, tetrahedra, etc). Dimension ``cell_index``
+    denotes the index of a cell in the collection, and dimension ``vertex_index`` denotes placement
+    (index) of a point in a cell (for example: 0, 1, or 2 for triangles; 0, 1, 2, or 3 for
+    tetrahedra).
 
     Example
     -------
     >>> cell_array = CellDataArray(
     ...     (1+1j) * np.random.random((4, 3)),
     ...     coords=dict(cell_index=np.arange(4), vertex_index=np.arange(3)),
     ... )
+    >>> # get indices of points composing cell number 3
+    >>> cell3 = cell_array.sel(cell_index=3)
+    >>> # get indices of points that represent the first vertex in each cell
+    >>> first_vertices = cell_array.sel(vertex_index=0)
     """
 
     __slots__ = ()
     _dims = ("cell_index", "vertex_index")
 
 
 class IndexedDataArray(DataArray):
-    """Indexed data array.
+    """Stores a one-dimensional array enumerated by coordinate ``index``. It is typically used
+    in conjuction with a ``PointDataArray`` to store point-associated data or a ``CellDataArray``
+    to store cell-associated data.
 
     Example
     -------