Further cleanup

Author: daquinteroflex

tests/test_plugins/smatrix/test_terminal_component_modeler.py

@@ -45,7 +45,7 @@ def run_component_modeler(monkeypatch, modeler: TerminalComponentModeler):
     )
     monkeypatch.setattr(
         td.plugins.smatrix.utils,
-        "_check_port_impedance_sign",
+        "check_port_impedance_sign",
         lambda Z_numpy: np.ndarray([]),
     )
 

tidy3d/plugins/smatrix/component_modelers/terminal.py

@@ -304,25 +304,25 @@ def run(self, path_dir: str = DEFAULT_DATA_DIR):
     ##### Backwards compatibility methods #####
     @staticmethod
     def _check_port_impedance_sign(Z_numpy: np.ndarray):
-        from tidy3d.plugins.smatrix.utils import _check_port_impedance_sign
+        from tidy3d.plugins.smatrix.utils import check_port_impedance_sign
 
-        return _check_port_impedance_sign(Z_numpy)
+        return check_port_impedance_sign(Z_numpy)
 
     @staticmethod
     def _compute_F(Z_numpy: np.array):
         """Helper to convert port impedance matrix to F, which is used for
         computing generalized scattering parameters."""
-        from tidy3d.plugins.smatrix.utils import _compute_F
+        from tidy3d.plugins.smatrix.utils import compute_F
 
-        return _compute_F(Z_numpy)
+        return compute_F(Z_numpy)
 
     def _construct_smatrix(self) -> TerminalPortDataArray:
-        from tidy3d.plugins.smatrix.run import construct_smatrix
+        from tidy3d.plugins.smatrix.local_run import construct_smatrix
 
         return construct_smatrix(self)
 
     def _internal_construct_smatrix(self, batch_data: typing.Any = None) -> TerminalPortDataArray:
-        from tidy3d.plugins.smatrix.run import construct_smatrix
+        from tidy3d.plugins.smatrix.local_run import construct_smatrix
 
         return construct_smatrix(self)
 
@@ -402,7 +402,7 @@ def compute_port_VI(
     def compute_power_wave_amplitudes_at_each_port(
         self, port_reference_impedances: PortDataArray, sim_data: SimulationData
     ) -> tuple[PortDataArray, PortDataArray]:
-        from tidy3d.plugins.smatrix.run import compute_power_wave_amplitudes_at_each_port
+        from tidy3d.plugins.smatrix.local_run import compute_power_wave_amplitudes_at_each_port
 
         data = compute_power_wave_amplitudes_at_each_port(
             simulation=self, port_reference_impedances=port_reference_impedances, sim_data=sim_data

tidy3d/plugins/smatrix/data/data.py

@@ -110,7 +110,7 @@ def get_antenna_metrics_data(
             Container with antenna parameters including directivity, gain, and radiation efficiency,
             computed from the superposition of fields from all excited ports.
         """
-        from tidy3d.plugins.smatrix.run import compute_power_wave_amplitudes_at_each_port
+        from tidy3d.plugins.smatrix.local_run import compute_power_wave_amplitudes_at_each_port
 
         # Use the first port as default if none specified
         if port_amplitudes is None:
@@ -179,14 +179,14 @@ def get_antenna_metrics_data(
     @cached_property
     def port_reference_impedances(self) -> PortDataArray:
         """The reference impedance used at each port for definining power wave amplitudes."""
-        from tidy3d.plugins.smatrix.run import port_reference_impedances
+        from tidy3d.plugins.smatrix.local_run import port_reference_impedances
 
         return port_reference_impedances(self.simulation)
 
     def compute_power_wave_amplitudes_at_each_port(
         self, port_reference_impedances: PortDataArray, sim_data: SimulationData
     ) -> tuple[PortDataArray, PortDataArray]:
-        from tidy3d.plugins.smatrix.run import compute_power_wave_amplitudes_at_each_port
+        from tidy3d.plugins.smatrix.local_run import compute_power_wave_amplitudes_at_each_port
 
         data = compute_power_wave_amplitudes_at_each_port(
             simulation=self.simulation,

tidy3d/plugins/smatrix/run.py renamed to tidy3d/plugins/smatrix/local_run.py

@@ -9,7 +9,7 @@
 from tidy3d.components.data.sim_data import SimulationData
 from tidy3d.plugins.smatrix.data.terminal import PortDataArray, TerminalPortDataArray
 from tidy3d.plugins.smatrix.ports.wave import WavePort
-from tidy3d.plugins.smatrix.utils import _check_port_impedance_sign, _compute_F, compute_port_VI
+from tidy3d.plugins.smatrix.utils import check_port_impedance_sign, compute_F, compute_port_VI
 
 
 def construct_smatrix(simulation, batch_data: typing.Any = None) -> TerminalPortDataArray:
@@ -126,14 +126,14 @@ def compute_power_wave_amplitudes_at_each_port(
     Z_numpy = port_reference_impedances.values
 
     # Check to make sure sign is consistent for all impedance values
-    _check_port_impedance_sign(Z_numpy)
+    check_port_impedance_sign(Z_numpy)
 
     # # Check for negative real part of port impedance and flip the V and Z signs accordingly
     negative_real_Z = np.real(Z_numpy) < 0
     V_numpy = np.where(negative_real_Z, -V_numpy, V_numpy)
     Z_numpy = np.where(negative_real_Z, -Z_numpy, Z_numpy)
 
-    F_numpy = _compute_F(Z_numpy)
+    F_numpy = compute_F(Z_numpy)
 
     # Equation 4.67 - Pozar - Microwave Engineering 4ed
     a.values = F_numpy * (V_numpy + Z_numpy * I_numpy)

tidy3d/plugins/smatrix/utils.py

@@ -85,7 +85,7 @@ def compute_power_delivered_by_port(
     return 0.5 * (np.abs(a) ** 2 - np.abs(b) ** 2)
 
 
-def _compute_F(Z_numpy: np.array):
+def compute_F(Z_numpy: np.array):
     """Helper to convert port impedance matrix to F, which is used for
     computing generalized scattering parameters."""
     return 1.0 / (2.0 * np.sqrt(np.real(Z_numpy)))
@@ -122,7 +122,7 @@ def s_to_z(s_matrix: TerminalPortDataArray, reference: Union[complex, PortDataAr
         shape_left = (len(s_matrix.f), len(s_matrix.port_out), 1)
         shape_right = (len(s_matrix.f), 1, len(s_matrix.port_in))
         Zport = reference.values.reshape(shape_right)
-        F = _compute_F(Zport).reshape(shape_right)
+        F = compute_F(Zport).reshape(shape_right)
         Finv = (1.0 / F).reshape(shape_left)
         FinvSF = Finv * s_vals * F
         RHS = eye * np.conj(Zport) + FinvSF * Zport
@@ -136,7 +136,7 @@ def s_to_z(s_matrix: TerminalPortDataArray, reference: Union[complex, PortDataAr
     return z_matrix
 
 
-def _check_port_impedance_sign(Z_numpy: np.ndarray):
+def check_port_impedance_sign(Z_numpy: np.ndarray):
     """Sanity check for consistent sign of real part of Z for each port across all frequencies."""
     for port_idx in range(Z_numpy.shape[1]):
         port_Z = Z_numpy[:, port_idx]