changed the name of the "transpose" argument to "swap_axes" everywhere

Author: jewettaijfc

tidy3d/components/base_sim/simulation.py

@@ -251,7 +251,7 @@ def plot(
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
         fill_structures: bool = True,
-        transpose: bool = False,
+        swap_axes: bool = False,
         **patch_kwargs,
     ) -> Ax:
         """Plot each of simulation's components on a plane defined by one nonzero x,y,z coordinate.
@@ -283,23 +283,23 @@ def plot(
         """
 
         hlim, vlim = Scene._get_plot_lims(
-            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
         ax = self.scene.plot_structures(
-            ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, fill=fill_structures, transpose=transpose
+            ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, fill=fill_structures, swap_axes=swap_axes
         )
-        ax = self.plot_sources(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=source_alpha, transpose=transpose)
-        ax = self.plot_monitors(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=monitor_alpha, transpose=transpose)
+        ax = self.plot_sources(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=source_alpha, swap_axes=swap_axes)
+        ax = self.plot_monitors(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=monitor_alpha, swap_axes=swap_axes)
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
-        ax = self.plot_boundaries(ax=ax, x=x, y=y, z=z, transpose=transpose)
-        ax = self.plot_symmetries(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose)
+        ax = self.plot_boundaries(ax=ax, x=x, y=y, z=z, swap_axes=swap_axes)
+        ax = self.plot_symmetries(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes)
 
         # Add the default axis labels, tick labels, and title
         ax = Box.add_ax_labels_and_title(
-            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, transpose=transpose
+            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, swap_axes=swap_axes
         )
 
         return ax
@@ -315,7 +315,7 @@ def plot_sources(
         vlim: Optional[tuple[float, float]] = None,
         alpha: Optional[float] = None,
         ax: Ax = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
     ) -> Ax:
         """Plot each of simulation's sources on a plane defined by one nonzero x,y,z coordinate.
 
@@ -343,13 +343,13 @@ def plot_sources(
         """
         bounds = self.bounds
         for source in self.sources:
-            ax = source.plot(x=x, y=y, z=z, alpha=alpha, ax=ax, sim_bounds=bounds, transpose=transpose)
+            ax = source.plot(x=x, y=y, z=z, alpha=alpha, ax=ax, sim_bounds=bounds, swap_axes=swap_axes)
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
         # Add the default axis labels, tick labels, and title
         ax = Box.add_ax_labels_and_title(
-            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, transpose=transpose
+            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, swap_axes=swap_axes
         )
         return ax
 
@@ -364,7 +364,7 @@ def plot_monitors(
         vlim: Optional[tuple[float, float]] = None,
         alpha: Optional[float] = None,
         ax: Ax = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
     ) -> Ax:
         """Plot each of simulation's monitors on a plane defined by one nonzero x,y,z coordinate.
 
@@ -392,13 +392,13 @@ def plot_monitors(
         """
         bounds = self.bounds
         for monitor in self.monitors:
-            ax = monitor.plot(x=x, y=y, z=z, alpha=alpha, ax=ax, sim_bounds=bounds, transpose=transpose)
+            ax = monitor.plot(x=x, y=y, z=z, alpha=alpha, ax=ax, sim_bounds=bounds, swap_axes=swap_axes)
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
         # Add the default axis labels, tick labels, and title
         ax = Box.add_ax_labels_and_title(
-            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, transpose=transpose
+            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, swap_axes=swap_axes
         )
         return ax
 
@@ -412,7 +412,7 @@ def plot_symmetries(
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
         ax: Ax = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
     ) -> Ax:
         """Plot each of simulation's symmetries on a plane defined by one nonzero x,y,z coordinate.
 
@@ -444,13 +444,13 @@ def plot_symmetries(
                 continue
             sym_box = self._make_symmetry_box(sym_axis=sym_axis)
             plot_params = self._make_symmetry_plot_params(sym_value=sym_value)
-            ax = sym_box.plot(x=x, y=y, z=z, ax=ax, transpose=transpose, **plot_params.to_kwargs())
+            ax = sym_box.plot(x=x, y=y, z=z, ax=ax, swap_axes=swap_axes, **plot_params.to_kwargs())
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
         # Add the default axis labels, tick labels, and title
         ax = Box.add_ax_labels_and_title(
-            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, transpose=transpose
+            ax=ax, x=x, y=y, z=z, plot_length_units=self.plot_length_units, swap_axes=swap_axes
         )
         return ax
 
@@ -486,7 +486,7 @@ def plot_boundaries(
         y: Optional[float] = None,
         z: Optional[float] = None,
         ax: Ax = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
         **kwargs,
     ) -> Ax:
         """Plot the simulation boundary conditions as lines on a plane
@@ -524,7 +524,7 @@ def plot_structures(
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
         fill: bool = True,
-        transpose: bool = False,
+        swap_axes: bool = False,
     ) -> Ax:
         """Plot each of simulation's structures on a plane defined by one nonzero x,y,z coordinate.
 
@@ -551,11 +551,11 @@ def plot_structures(
         """
 
         hlim_new, vlim_new = Scene._get_plot_lims(
-            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
         return self.scene.plot_structures(
-            x=x, y=y, z=z, ax=ax, hlim=hlim_new, vlim=vlim_new, fill=fill, transpose=transpose
+            x=x, y=y, z=z, ax=ax, hlim=hlim_new, vlim=vlim_new, fill=fill, swap_axes=swap_axes
         )
 
     @equal_aspect
@@ -572,7 +572,7 @@ def plot_structures_eps(
         ax: Ax = None,
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
     ) -> Ax:
         """Plot each of simulation's structures on a plane defined by one nonzero x,y,z coordinate.
         The permittivity is plotted in grayscale based on its value at the specified frequency.
@@ -610,7 +610,7 @@ def plot_structures_eps(
         """
 
         hlim, vlim = Scene._get_plot_lims(
-            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
         return self.scene.plot_structures_eps(
@@ -624,7 +624,7 @@ def plot_structures_eps(
             hlim=hlim,
             vlim=vlim,
             reverse=reverse,
-            transpose=transpose,
+            swap_axes=swap_axes,
         )
 
     @equal_aspect
@@ -640,7 +640,7 @@ def plot_structures_heat_conductivity(
         ax: Ax = None,
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
     ) -> Ax:
         """Plot each of simulation's structures on a plane defined by one nonzero x,y,z coordinate.
         The permittivity is plotted in grayscale based on its value at the specified frequency.
@@ -678,7 +678,7 @@ def plot_structures_heat_conductivity(
         """
 
         hlim, vlim = Scene._get_plot_lims(
-            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
         return self.scene.plot_structures_heat_conductivity(
@@ -691,7 +691,7 @@ def plot_structures_heat_conductivity(
             hlim=hlim,
             vlim=vlim,
             reverse=reverse,
-            transpose=transpose,
+            swap_axes=swap_axes,
         )
 
     @classmethod

tidy3d/components/eme/simulation.py

@@ -306,7 +306,7 @@ def plot_eme_ports(
         ax: Ax = None,
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
         **kwargs,
     ) -> Ax:
         """Plot the EME ports."""
@@ -316,15 +316,15 @@ def plot_eme_ports(
         rmax = self.geometry.bounds[1][self.axis]
         ports = np.array([rmin + self.port_offsets[0], rmax - self.port_offsets[1]])
         axis, _ = self.parse_xyz_kwargs(x=x, y=y, z=z)
-        _, (axis_x, axis_y) = self.pop_axis([0, 1, 2], axis=axis, transpose=transpose)
+        _, (axis_x, axis_y) = self.pop_axis([0, 1, 2], axis=axis, swap_axes=swap_axes)
         boundaries_x = []
         boundaries_y = []
         if axis_x == self.axis:
             boundaries_x = ports
         if axis_y == self.axis:
             boundaries_y = ports
-        _, (xmin, ymin) = self.pop_axis(self.simulation_bounds[0], axis=axis, transpose=transpose)
-        _, (xmax, ymax) = self.pop_axis(self.simulation_bounds[1], axis=axis, transpose=transpose)
+        _, (xmin, ymin) = self.pop_axis(self.simulation_bounds[0], axis=axis, swap_axes=swap_axes)
+        _, (xmax, ymax) = self.pop_axis(self.simulation_bounds[1], axis=axis, swap_axes=swap_axes)
         segs_x = [((bound, ymin), (bound, ymax)) for bound in boundaries_x]
         line_segments_x = mpl.collections.LineCollection(segs_x, **kwargs)
         segs_y = [((xmin, bound), (xmax, bound)) for bound in boundaries_y]
@@ -335,7 +335,7 @@ def plot_eme_ports(
         ax.add_collection(line_segments_y)
 
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
         return ax
@@ -351,7 +351,7 @@ def plot_eme_subgrid_boundaries(
         ax: Ax = None,
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
         **kwargs,
     ) -> Ax:
         """Plot the EME subgrid boundaries.
@@ -365,15 +365,15 @@ def plot_eme_subgrid_boundaries(
         subgrid_boundaries = np.array(eme_grid_spec.subgrid_boundaries)
         subgrids = eme_grid_spec.subgrids
         axis, _ = self.parse_xyz_kwargs(x=x, y=y, z=z)
-        _, (axis_x, axis_y) = self.pop_axis([0, 1, 2], axis=axis, transpose=transpose)
+        _, (axis_x, axis_y) = self.pop_axis([0, 1, 2], axis=axis, swap_axes=swap_axes)
         boundaries_x = []
         boundaries_y = []
         if axis_x == self.axis:
             boundaries_x = subgrid_boundaries
         if axis_y == self.axis:
             boundaries_y = subgrid_boundaries
-        _, (xmin, ymin) = self.pop_axis(self.simulation_bounds[0], axis=axis, transpose=transpose)
-        _, (xmax, ymax) = self.pop_axis(self.simulation_bounds[1], axis=axis, transpose=transpose)
+        _, (xmin, ymin) = self.pop_axis(self.simulation_bounds[0], axis=axis, swap_axes=swap_axes)
+        _, (xmax, ymax) = self.pop_axis(self.simulation_bounds[1], axis=axis, swap_axes=swap_axes)
         segs_x = [((bound, ymin), (bound, ymax)) for bound in boundaries_x]
         line_segments_x = mpl.collections.LineCollection(segs_x, **kwargs)
         segs_y = [((xmin, bound), (xmax, bound)) for bound in boundaries_y]
@@ -384,12 +384,12 @@ def plot_eme_subgrid_boundaries(
         ax.add_collection(line_segments_y)
 
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
         for subgrid in subgrids:
             ax = self.plot_eme_subgrid_boundaries(
-                eme_grid_spec=subgrid, x=x, y=y, z=z, ax=ax, hlim=hlim, vlim=vlim, transpose=transpose, **kwargs
+                eme_grid_spec=subgrid, x=x, y=y, z=z, ax=ax, hlim=hlim, vlim=vlim, swap_axes=swap_axes, **kwargs
             )
 
         return ax
@@ -404,23 +404,23 @@ def plot_eme_grid(
         ax: Ax = None,
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
         **kwargs,
     ) -> Ax:
         """Plot the EME grid."""
         kwargs.setdefault("linewidth", 0.2)
         kwargs.setdefault("colors", "black")
         cell_boundaries = self.eme_grid.boundaries
         axis, _ = self.parse_xyz_kwargs(x=x, y=y, z=z)
-        _, (axis_x, axis_y) = self.pop_axis([0, 1, 2], axis=axis, transpose=transpose)
+        _, (axis_x, axis_y) = self.pop_axis([0, 1, 2], axis=axis, swap_axes=swap_axes)
         boundaries_x = []
         boundaries_y = []
         if axis_x == self.axis:
             boundaries_x = cell_boundaries
         if axis_y == self.axis:
             boundaries_y = cell_boundaries
-        _, (xmin, ymin) = self.pop_axis(self.simulation_bounds[0], axis=axis, transpose=transpose)
-        _, (xmax, ymax) = self.pop_axis(self.simulation_bounds[1], axis=axis, transpose=transpose)
+        _, (xmin, ymin) = self.pop_axis(self.simulation_bounds[0], axis=axis, swap_axes=swap_axes)
+        _, (xmax, ymax) = self.pop_axis(self.simulation_bounds[1], axis=axis, swap_axes=swap_axes)
         segs_x = [((bound, ymin), (bound, ymax)) for bound in boundaries_x]
         line_segments_x = mpl.collections.LineCollection(segs_x, **kwargs)
         segs_y = [((xmin, bound), (xmax, bound)) for bound in boundaries_y]
@@ -431,7 +431,7 @@ def plot_eme_grid(
         ax.add_collection(line_segments_y)
 
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
         return ax
@@ -448,7 +448,7 @@ def plot(
         monitor_alpha: Optional[float] = None,
         hlim: Optional[tuple[float, float]] = None,
         vlim: Optional[tuple[float, float]] = None,
-        transpose: bool = False,
+        swap_axes: bool = False,
         **patch_kwargs,
     ) -> Ax:
         """Plot each of simulation's components on a plane defined by one nonzero x,y,z coordinate.
@@ -479,23 +479,23 @@ def plot(
         """
 
         hlim, vlim = Scene._get_plot_lims(
-            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
 
-        ax = self.scene.plot_structures(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose)
-        ax = self.plot_sources(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=source_alpha, transpose=transpose)
-        ax = self.plot_monitors(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=monitor_alpha, transpose=transpose)
+        ax = self.scene.plot_structures(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes)
+        ax = self.plot_sources(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=source_alpha, swap_axes=swap_axes)
+        ax = self.plot_monitors(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, alpha=monitor_alpha, swap_axes=swap_axes)
         ax = Scene._set_plot_bounds(
-            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            bounds=self.simulation_bounds, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
-        ax = self.plot_boundaries(ax=ax, x=x, y=y, z=z, transpose=transpose)
-        ax = self.plot_symmetries(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose)
+        ax = self.plot_boundaries(ax=ax, x=x, y=y, z=z, swap_axes=swap_axes)
+        ax = self.plot_symmetries(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes)
 
-        ax = self.plot_eme_grid(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose)
+        ax = self.plot_eme_grid(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes)
         ax = self.plot_eme_subgrid_boundaries(
-            eme_grid_spec=self.eme_grid_spec, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose
+            eme_grid_spec=self.eme_grid_spec, ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes
         )
-        ax = self.plot_eme_ports(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, transpose=transpose)
+        ax = self.plot_eme_ports(ax=ax, x=x, y=y, z=z, hlim=hlim, vlim=vlim, swap_axes=swap_axes)
         return ax
 
     @cached_property