Merge pull request #54 from BYUCamachoLab/simulation

Simulation contexts

Author: AustP

.github/workflows/build-and-test.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Lint with flake8
         run: |
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          flake8 . --count --ignore=E501,E741,W503,W605 --max-complexity=10 --statistics
+          flake8 . --count --ignore=E501,E741,W503,W605 --max-complexity=12 --statistics
       - name: Run Tox
         run: tox -e py
     strategy:

docs/source/reference/api.rst

@@ -28,6 +28,11 @@ API
   :inherited-members:
   :show-inheritance:
 
+.. automodule:: simphony.simulation
+  :members:
+  :inherited-members:
+  :show-inheritance:
+
 .. automodule:: simphony.simulators
   :members:
   :inherited-members:

simphony/formatters.py

@@ -220,12 +220,15 @@ class CircuitJSONFormatter:
     """This class handles converting a circuit to JSON and vice-versa."""
 
     def format(self, circuit: "Circuit", freqs: np.array) -> str:
+        from simphony.simulation import SimulationModel
         from simphony.simulators import Simulator
 
         data = {"components": [], "connections": []}
         for i, component in enumerate(circuit):
             # skip simulators
-            if isinstance(component, Simulator):
+            if isinstance(component, Simulator) or isinstance(
+                component, SimulationModel
+            ):
                 continue
 
             # get a representation for each component

simphony/layout.py

@@ -136,6 +136,15 @@ def pins(self) -> List["Pin"]:
         """Returns the pins for the circuit."""
         return self.to_subcircuit(permanent=False).pins
 
+    def get_pin_index(self, pin: "Pin") -> int:
+        """Gets the pin index for the specified pin in the scattering
+        parameters."""
+        for i, _pin in enumerate(self.pins):
+            if _pin == pin:
+                return i
+
+        raise ValueError("The pin must belong to the circuit.")
+
     def s_parameters(self, freqs: "np.array") -> "np.ndarray":
         """Returns the scattering parameters for the circuit."""
         return self.to_subcircuit(permanent=False).s_parameters(freqs)

simphony/models.py

@@ -19,16 +19,15 @@ class is the base class for all models. The ``Subcircuit`` class is where
 """
 
 import os
-from typing import TYPE_CHECKING, ClassVar, Dict, List, Optional, Tuple, Union
+from typing import ClassVar, Dict, List, Optional, Tuple, Union
+
+import numpy as np
 
 from simphony.connect import create_block_diagonal, innerconnect_s
 from simphony.formatters import ModelFormatter, ModelJSONFormatter
 from simphony.layout import Circuit
 from simphony.pins import Pin, PinList
 
-if TYPE_CHECKING:
-    import numpy as np
-
 
 class Model:
     """The basic element type describing the model for a component with
@@ -230,7 +229,7 @@ def _on_disconnect_recursive(self, circuit: Circuit) -> None:
                 if circuit._add(component):
                     component._on_disconnect_recursive(circuit)
 
-    def connect(self, component_or_pin: Union["Model", Pin]) -> None:
+    def connect(self, component_or_pin: Union["Model", Pin]) -> "Model":
         """Connects the next available (unconnected) pin from this component to
         the component/pin passed in as the argument.
 
@@ -239,13 +238,14 @@ def connect(self, component_or_pin: Union["Model", Pin]) -> None:
         component.
         """
         self._get_next_unconnected_pin().connect(component_or_pin)
+        return self
 
     def disconnect(self) -> None:
         """Disconnects this component from all other components."""
         for pin in self.pins:
             pin.disconnect()
 
-    def interface(self, component: "Model") -> None:
+    def interface(self, component: "Model") -> "Model":
         """Interfaces this component to the component passed in by connecting
         pins with the same names.
 
@@ -256,6 +256,8 @@ def interface(self, component: "Model") -> None:
                 if selfpin.name[0:3] != "pin" and selfpin.name == componentpin.name:
                     selfpin.connect(componentpin)
 
+        return self
+
     def monte_carlo_s_parameters(self, freqs: "np.array") -> "np.ndarray":
         """Implements the monte carlo routine for the given Model.
 
@@ -278,7 +280,7 @@ def monte_carlo_s_parameters(self, freqs: "np.array") -> "np.ndarray":
         """
         return self.s_parameters(freqs)
 
-    def multiconnect(self, *connections: Union["Model", Pin, None]) -> None:
+    def multiconnect(self, *connections: Union["Model", Pin, None]) -> "Model":
         """Connects this component to the specified connections by looping
         through each connection and connecting it with the corresponding pin.
 
@@ -293,6 +295,8 @@ def multiconnect(self, *connections: Union["Model", Pin, None]) -> None:
             if connection is not None:
                 self.pins[index].connect(connection)
 
+        return self
+
     def regenerate_monte_carlo_parameters(self) -> None:
         """Regenerates parameters used to generate monte carlo s-matrices.
 
@@ -540,6 +544,7 @@ def _s_parameters(
             The method name to call to get the scattering parameters.
             Either 's_parameters' or 'monte_carlo_s_parameters'
         """
+        from simphony.simulation import SimulationModel
         from simphony.simulators import Simulator
 
         all_pins = []
@@ -549,16 +554,36 @@ def _s_parameters(
         # merge all of the s_params into one giant block diagonal matrix
         for component in self._wrapped_circuit:
             # simulators don't have scattering parameters
-            if isinstance(component, Simulator):
+            if isinstance(component, Simulator) or isinstance(
+                component, SimulationModel
+            ):
                 continue
 
             # get the s_params from the cache if possible
             if s_parameters_method == "s_parameters":
-                try:
-                    s_params = self.__class__.scache[component]
-                except KeyError:
-                    s_params = getattr(component, s_parameters_method)(freqs)
-                    self.__class__.scache[component] = s_params
+                # each frequency has a different s-matrix, so we need to cache
+                # the s-matrices by frequency as well as component
+                s_params = []
+                for freq in freqs:
+                    try:
+                        # use the cached s-matrix if available
+                        s_matrix = self.__class__.scache[component][freq]
+                    except KeyError:
+                        # make sure the frequency dict is created
+                        if component not in self.__class__.scache:
+                            self.__class__.scache[component] = {}
+
+                        # store the s-matrix for the frequency and component
+                        s_matrix = getattr(component, s_parameters_method)(
+                            np.array([freq])
+                        )[0]
+                        self.__class__.scache[component][freq] = s_matrix
+
+                    # add the s-matrix to our list of s-matrices
+                    s_params.append(s_matrix)
+
+                # convert to numpy array for the rest of the function
+                s_params = np.array(s_params)
             elif s_parameters_method == "monte_carlo_s_parameters":
                 # don't cache Monte Carlo scattering parameters
                 s_params = getattr(component, s_parameters_method)(freqs)

simphony/pins.py

@@ -53,9 +53,12 @@ def _isconnected(self, *, include_simulators: bool = True) -> bool:
         if include_simulators:
             return True
 
+        from simphony.simulation import SimulationModel
         from simphony.simulators import Simulator
 
-        return not isinstance(self._connection._component, Simulator)
+        return not isinstance(
+            self._connection._component, Simulator
+        ) and not isinstance(self._connection._component, SimulationModel)
 
     def connect(self, pin_or_component: Union["Pin", "Model"]) -> None:
         """Connects this pin to the pin/component that is passed in.