renamed the "swap_axes" argument --> "transpose"

Author: jewettaijfc

tests/test_components/test_geometry.py

@@ -85,14 +85,14 @@
 _, AX = plt.subplots()
 
 
-@pytest.mark.parametrize("component, swap_axes", zip(GEO_TYPES, [True, False]))
-def test_plot(component, swap_axes):
-    _ = component.plot(z=0, ax=AX, swap_axes=swap_axes)
+@pytest.mark.parametrize("component, transpose", zip(GEO_TYPES, [True, False]))
+def test_plot(component, transpose):
+    _ = component.plot(z=0, ax=AX, transpose=transpose)
     plt.close()
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_plot_with_units(swap_axes):
-    _ = BOX.plot(z=0, ax=AX, plot_length_units="nm", swap_axes=swap_axes)
+@pytest.mark.parametrize("transpose", [True, False])
+def test_plot_with_units(transpose):
+    _ = BOX.plot(z=0, ax=AX, plot_length_units="nm", transpose=transpose)
     plt.close()
 
 
@@ -204,11 +204,11 @@ def test_array_to_vertices():
     assert np.all(np.array(vertices) == np.array(vertices2))
 
 
-@pytest.mark.parametrize("component, swap_axes", zip(GEO_TYPES, [True, False]))
-def test_intersections_plane(component, swap_axes):
-    assert len(component.intersections_plane(z=0.2, swap_axes=swap_axes)) > 0
-    assert len(component.intersections_plane(x=0.2, swap_axes=swap_axes)) > 0
-    assert len(component.intersections_plane(x=10000, swap_axes=swap_axes)) == 0
+@pytest.mark.parametrize("component, transpose", zip(GEO_TYPES, [True, False]))
+def test_intersections_plane(component, transpose):
+    assert len(component.intersections_plane(z=0.2, transpose=transpose)) > 0
+    assert len(component.intersections_plane(x=0.2, transpose=transpose)) > 0
+    assert len(component.intersections_plane(x=10000, transpose=transpose)) == 0
 
 
 def test_intersections_plane_inf():
@@ -778,39 +778,39 @@ def test_pop_axis():
         assert Ly == _Ly
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_pop_axis_and_swap(swap_axes):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_pop_axis_and_swap(transpose):
     b = td.Box(size=(1, 1, 1))
     for axis in range(3):
         coords = (1, 2, 3)
-        Lz, (Lx, Ly) = b.pop_axis_and_swap(coords, axis=axis, swap_axes=swap_axes)
-        _coords = b.unpop_axis_and_swap(Lz, (Lx, Ly), axis=axis, swap_axes=swap_axes)
+        Lz, (Lx, Ly) = b.pop_axis_and_swap(coords, axis=axis, transpose=transpose)
+        _coords = b.unpop_axis_and_swap(Lz, (Lx, Ly), axis=axis, transpose=transpose)
         assert all(c == _c for (c, _c) in zip(coords, _coords))
-        _Lz, (_Lx, _Ly) = b.pop_axis_and_swap(_coords, axis=axis, swap_axes=swap_axes)
+        _Lz, (_Lx, _Ly) = b.pop_axis_and_swap(_coords, axis=axis, transpose=transpose)
         assert Lz == _Lz
         assert Lx == _Lx
         assert Ly == _Ly
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_2b_box_intersections(swap_axes):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_2b_box_intersections(transpose):
     plane = td.Box(size=(1, 4, 0))
     box1 = td.Box(size=(1, 1, 1))
     box2 = td.Box(size=(1, 1, 1), center=(3, 0, 0))
 
-    result = plane.intersections_with(box1, swap_axes=swap_axes)
+    result = plane.intersections_with(box1, transpose=transpose)
     assert len(result) == 1
     assert result[0].geom_type == "Polygon"
-    assert len(plane.intersections_with(box2, swap_axes=swap_axes)) == 0
+    assert len(plane.intersections_with(box2, transpose=transpose)) == 0
 
     with pytest.raises(ValidationError):
-        _ = box1.intersections_with(box2, swap_axes=swap_axes)
+        _ = box1.intersections_with(box2, transpose=transpose)
 
-    assert len(box1.intersections_2dbox(plane, swap_axes=swap_axes)) == 1
-    assert len(box2.intersections_2dbox(plane, swap_axes=swap_axes)) == 0
+    assert len(box1.intersections_2dbox(plane, transpose=transpose)) == 1
+    assert len(box2.intersections_2dbox(plane, transpose=transpose)) == 0
 
     with pytest.raises(ValidationError):
-        _ = box2.intersections_2dbox(box1, swap_axes=swap_axes)
+        _ = box2.intersections_2dbox(box1, transpose=transpose)
 
 
 def test_polyslab_merge():
@@ -952,8 +952,8 @@ def test_to_gds(geometry, tmp_path):
     assert len(cell.polygons) == 0
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_custom_surface_geometry(swap_axes, tmp_path):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_custom_surface_geometry(transpose, tmp_path):
     # create tetrahedron STL
     vertices = np.array([[0, 0, 0], [1, 0, 0], [0, 1, 0], [0, 0, 1]])
     faces = np.array([[1, 2, 3], [0, 3, 2], [0, 1, 3], [0, 2, 1]])
@@ -987,11 +987,11 @@ def test_custom_surface_geometry(swap_axes, tmp_path):
 
     # test intersections
     assert shapely.equals(
-        geom.intersections_plane(x=0, swap_axes=swap_axes),
+        geom.intersections_plane(x=0, transpose=transpose),
         shapely.Polygon([[0, 0], [0, 1], [1, 0]]),
     )
     assert shapely.equals(
-        geom.intersections_plane(z=0.5, swap_axes=swap_axes),
+        geom.intersections_plane(z=0.5, transpose=transpose),
         shapely.Polygon([[0, 0], [0, 0.5], [0.5, 0]]),
     )
 
@@ -1001,7 +1001,7 @@ def test_custom_surface_geometry(swap_axes, tmp_path):
 
     # test plot
     _, ax = plt.subplots()
-    _ = geom.plot(z=0.1, ax=ax, swap_axes=swap_axes)
+    _ = geom.plot(z=0.1, ax=ax, transpose=transpose)
     plt.close()
 
     # test inconsistent winding
@@ -1051,7 +1051,7 @@ def test_custom_surface_geometry(swap_axes, tmp_path):
         boundary_spec=td.BoundarySpec.all_sides(td.PML()),
     )
     _, ax = plt.subplots()
-    _ = sim.plot(y=0, ax=ax, swap_axes=swap_axes)
+    _ = sim.plot(y=0, ax=ax, transpose=transpose)
     plt.close()
 
     # allow small triangles

tests/test_components/test_heat.py

@@ -335,12 +335,12 @@ def make_heat_sim(include_custom_source: bool = True):
     return heat_sim
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_heat_sim(swap_axes):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_heat_sim(transpose):
     bc_temp, bc_flux, bc_conv = make_heat_bcs()
     heat_sim = make_heat_sim()
 
-    _ = heat_sim.plot(x=0, swap_axes=swap_axes)
+    _ = heat_sim.plot(x=0, transpose=transpose)
 
     # wrong names given
     for pl in [
@@ -374,14 +374,14 @@ def test_heat_sim(swap_axes):
     with pytest.raises(pd.ValidationError):
         heat_sim.updated_copy(monitors=[temp_mnt, temp_mnt])
 
-    _ = heat_sim.plot(x=0, swap_axes=swap_axes)
+    _ = heat_sim.plot(x=0, transpose=transpose)
     plt.close()
 
-    _ = heat_sim.plot_heat_conductivity(y=0, swap_axes=swap_axes)
+    _ = heat_sim.plot_heat_conductivity(y=0, transpose=transpose)
     plt.close()
 
     heat_sim_sym = heat_sim.updated_copy(symmetry=(0, 1, 1))
-    _ = heat_sim_sym.plot_heat_conductivity(z=0, colorbar="source", swap_axes=swap_axes)
+    _ = heat_sim_sym.plot_heat_conductivity(z=0, colorbar="source", transpose=transpose)
     plt.close()
 
     # no negative symmetry

tests/test_components/test_heat_charge.py

@@ -852,8 +852,8 @@ def test_heat_charge_sources(structures):
         _ = td.HeatSource(structures=["solid_structure"], rate="100")
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_heat_charge_simulation(swap_axes, simulation_data):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_heat_charge_simulation(transpose, simulation_data):
     """Tests 'HeatChargeSimulation' and 'ConductionSimulation' objects."""
     heat_sim_data, cond_sim_data, voltage_capacitance_sim_data, current_voltage_simulation_data = (
         simulation_data
@@ -877,16 +877,16 @@ def test_heat_charge_simulation(swap_axes, simulation_data):
         "Current-Voltage simulation should be created successfully."
     )
 
-    _ = heat_sim.plot_heat_conductivity(x=0, swap_axes=swap_axes)
+    _ = heat_sim.plot_heat_conductivity(x=0, transpose=transpose)
     plt.close()
-    _ = heat_sim.plot_property(x=0, property="heat_conductivity", swap_axes=swap_axes)
+    _ = heat_sim.plot_property(x=0, property="heat_conductivity", transpose=transpose)
     plt.close()
-    _ = cond_sim.plot_property(x=0, property="electric_conductivity", swap_axes=swap_axes)
+    _ = cond_sim.plot_property(x=0, property="electric_conductivity", transpose=transpose)
     plt.close()
     for sim in (heat_sim, cond_sim, voltage_capacitance_sim, current_voltage_sim):
-        _ = sim.plot_boundaries(x=0, swap_axes=swap_axes)
+        _ = sim.plot_boundaries(x=0, transpose=transpose)
         plt.close()
-        _ = sim.plot_sources(x=0, swap_axes=swap_axes)
+        _ = sim.plot_sources(x=0, transpose=transpose)
         plt.close()
 
 
@@ -1446,8 +1446,8 @@ def test_plotting_functions(simulation_data):
         heat_sim_data.plot_field("test", invalid_param=0)
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_bandgap_monitor(swap_axes):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_bandgap_monitor(transpose):
     """Test energy bandgap monitor ploting function."""
     # create a triangle grid
     tri_grid_points = td.PointDataArray(
@@ -1587,8 +1587,8 @@ def test_bandgap_monitor(swap_axes):
 
     # test check for the voltage value in the list of arguments
 
-    tri_single_voltage_data.plot(x=0.0, swap_axes=swap_axes)
-    tri_multi_voltage_data.plot(x=0.0, voltage=1.0, swap_axes=swap_axes)
+    tri_single_voltage_data.plot(x=0.0, transpose=transpose)
+    tri_multi_voltage_data.plot(x=0.0, voltage=1.0, transpose=transpose)
 
     with pytest.raises(DataError):
         tri_multi_voltage_data.plot(x=0.0)

tests/test_components/test_scene.py

@@ -50,15 +50,15 @@ def test_validate_components_none():
     assert SCENE._validate_num_mediums(val=None) is None
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_plot_eps(swap_axes):
-    ax = SCENE_FULL.plot_eps(x=0, swap_axes=swap_axes)
+@pytest.mark.parametrize("transpose", [True, False])
+def test_plot_eps(transpose):
+    ax = SCENE_FULL.plot_eps(x=0, transpose=transpose)
     SCENE_FULL._add_cbar_eps(eps_min=1, eps_max=2, ax=ax)
     plt.close()
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_plot_eps_multiphysics(swap_axes):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_plot_eps_multiphysics(transpose):
     s = td.Scene(
         structures=[
             td.Structure(
@@ -72,22 +72,22 @@ def test_plot_eps_multiphysics(swap_axes):
         ]
     )
     assert s.structures[0].medium.name == "SiO2"
-    s.plot_eps(x=0, swap_axes=swap_axes)
+    s.plot_eps(x=0, transpose=transpose)
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_plot_eps_bounds(swap_axes):
-    _ = SCENE_FULL.plot_eps(x=0, hlim=[-0.45, 0.45], swap_axes=swap_axes)
+@pytest.mark.parametrize("transpose", [True, False])
+def test_plot_eps_bounds(transpose):
+    _ = SCENE_FULL.plot_eps(x=0, hlim=[-0.45, 0.45], transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot_eps(x=0, vlim=[-0.45, 0.45], swap_axes=swap_axes)
+    _ = SCENE_FULL.plot_eps(x=0, vlim=[-0.45, 0.45], transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot_eps(x=0, hlim=[-0.45, 0.45], vlim=[-0.45, 0.45], swap_axes=swap_axes)
+    _ = SCENE_FULL.plot_eps(x=0, hlim=[-0.45, 0.45], vlim=[-0.45, 0.45], transpose=transpose)
     plt.close()
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_plot(swap_axes):
-    SCENE_FULL.plot(x=0, swap_axes=swap_axes)
+@pytest.mark.parametrize("transpose", [True, False])
+def test_plot(transpose):
+    SCENE_FULL.plot(x=0, transpose=transpose)
     plt.close()
 
 
@@ -97,48 +97,48 @@ def test_plot_1d_scene():
     plt.close()
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_plot_bounds(swap_axes):
-    _ = SCENE_FULL.plot(x=0, hlim=[-0.45, 0.45], swap_axes=swap_axes)
+@pytest.mark.parametrize("transpose", [True, False])
+def test_plot_bounds(transpose):
+    _ = SCENE_FULL.plot(x=0, hlim=[-0.45, 0.45], transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot(x=0, vlim=[-0.45, 0.45], swap_axes=swap_axes)
+    _ = SCENE_FULL.plot(x=0, vlim=[-0.45, 0.45], transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot(x=0, hlim=[-0.45, 0.45], vlim=[-0.45, 0.45], swap_axes=swap_axes)
+    _ = SCENE_FULL.plot(x=0, hlim=[-0.45, 0.45], vlim=[-0.45, 0.45], transpose=transpose)
     plt.close()
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_structure_alpha(swap_axes):
-    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=None, swap_axes=swap_axes)
+@pytest.mark.parametrize("transpose", [True, False])
+def test_structure_alpha(transpose):
+    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=None, transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=-1, swap_axes=swap_axes)
+    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=-1, transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=1, swap_axes=swap_axes)
+    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=1, transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=0.5, swap_axes=swap_axes)
+    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=0.5, transpose=transpose)
     plt.close()
-    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=0.5, cbar=True, swap_axes=swap_axes)
+    _ = SCENE_FULL.plot_structures_eps(x=0, alpha=0.5, cbar=True, transpose=transpose)
     plt.close()
     new_structs = [
         td.Structure(geometry=s.geometry, medium=SCENE_FULL.medium) for s in SCENE_FULL.structures
     ]
     S2 = SCENE_FULL.copy(update={"structures": new_structs})
-    _ = S2.plot_structures_eps(x=0, alpha=0.5, swap_axes=swap_axes)
+    _ = S2.plot_structures_eps(x=0, alpha=0.5, transpose=transpose)
     plt.close()
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_plot_with_units(swap_axes):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_plot_with_units(transpose):
     scene_with_units = SCENE_FULL.updated_copy(plot_length_units="nm")
-    scene_with_units.plot(x=-0.5, swap_axes=swap_axes)
+    scene_with_units.plot(x=-0.5, transpose=transpose)
 
 
-@pytest.mark.parametrize("swap_axes", [True, False])
-def test_filter_structures(swap_axes):
+@pytest.mark.parametrize("transpose", [True, False])
+def test_filter_structures(transpose):
     s1 = td.Structure(geometry=td.Box(size=(1, 1, 1)), medium=SCENE.medium)
     s2 = td.Structure(geometry=td.Box(size=(1, 1, 1), center=(1, 1, 1)), medium=SCENE.medium)
     plane = td.Box(center=(0, 0, 1.5), size=(td.inf, td.inf, 0))
-    SCENE._filter_structures_plane_medium(structures=[s1, s2], plane=plane, swap_axes=swap_axes)
+    SCENE._filter_structures_plane_medium(structures=[s1, s2], plane=plane, transpose=transpose)
 
 
 def test_get_structure_plot_params():