Add TCM schema change

daquinteroflex · daquinteroflex · commit 6b47835230fa · 2025-08-20T10:30:36.000+03:00
diff --git a/docs/faq b/docs/faq
@@ -1 +1 @@
-Subproject commit 96107d9f4ad82789a4b92a7df898684dddd90f25
+Subproject commit 90eb3869d0fe7d3cb8f7917ab657931a1083e1ed
diff --git a/docs/notebooks b/docs/notebooks
@@ -1 +1 @@
-Subproject commit 2e0b4cc78202924694ef1db7a478c6f61149229a
+Subproject commit 2ae7d88eb1d8aa10d69b5cebb366fda8750411e9
diff --git a/schemas/TerminalComponentModeler.json b/schemas/TerminalComponentModeler.json
@@ -1,6 +1,6 @@
 {
   "title": "TerminalComponentModeler",
-  "description": "Tool for modeling two-terminal multiport devices and computing port parameters\nwith lumped and wave ports.\n\nParameters\n----------\nattrs : dict = {}\n    Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, ``attrs`` are mutable. For example, the following is allowed for setting an ``attr`` ``obj.attrs['foo'] = bar``. Also note that `Tidy3D`` will raise a ``TypeError`` if ``attrs`` contain objects that can not be serialized. One can check if ``attrs`` are serializable by calling ``obj.json()``.\nsimulation : Simulation\n    Simulation describing the device without any sources present.\nports : Tuple[Union[LumpedPort, CoaxialLumpedPort, WavePort], ...] = ()\n    Collection of lumped and wave ports associated with the network. For each port, one simulation will be run with a source that is associated with the port.\nfreqs : Union[tuple[float, ...], ArrayLike[dtype=float, ndim=1]]\n    [units = Hz].  Array or list of frequencies at which to compute port parameters.\nremove_dc_component : bool = True\n    Whether to remove the DC component in the Gaussian pulse spectrum. If ``True``, the Gaussian pulse is modified at low frequencies to zero out the DC component, which is usually desirable so that the fields will decay. However, for broadband simulations, it may be better to have non-vanishing source power near zero frequency. Setting this to ``False`` results in an unmodified Gaussian pulse spectrum which can have a nonzero DC component.\nfolder_name : str = default\n    Name of the folder for the tasks on web.\nverbose : bool = False\n    Whether the :class:`.AbstractComponentModeler` should print status and progressbars.\ncallback_url : Optional[str] = None\n    Http PUT url to receive simulation finish event. The body content is a json file with fields ``{'id', 'status', 'name', 'workUnit', 'solverVersion'}``.\npath_dir : str = .\n    Base directory where data and batch will be downloaded.\nsolver_version : Optional[str] = None\n        batch_cached : Optional[Batch] = None\n    Optional field to specify ``batch``. Only used as a workaround internally so that ``batch`` is written when ``.to_file()`` and then the proper batch is loaded from ``.from_file()``. We recommend leaving unset as setting this field along with fields that were not used to create the task will cause errors.\nrun_only : Optional[Tuple[TypeVar, ...]] = None\n    Set of matrix indices that define the simulations to run. If ``None``, simulations will be run for all indices in the scattering matrix. If a tuple is given, simulations will be run only for the given matrix indices.\nelement_mappings : Tuple[tuple[~ElementType, ~ElementType, Union[tidy3d.components.types.tidycomplex, tidy3d.components.types.ComplexNumber]], ...] = ()\n    Tuple of S matrix element mappings, each described by a tuple of (input_element, output_element, coefficient), where the coefficient is the element_mapping coefficient describing the relationship between the input and output matrix element. If all elements of a given column of the scattering matrix are defined by ``element_mappings``, the simulation corresponding to this column is skipped automatically.\nradiation_monitors : Tuple[DirectivityMonitor, ...] = ()\n    Facilitates the calculation of figures-of-merit for antennas. These monitor will be included in every simulation and record the radiated fields. \nassume_ideal_excitation : bool = False\n    If ``True``, only the excited port is assumed to have a nonzero incident wave amplitude power. This choice simplifies the calculation of the scattering matrix. If ``False``, every entry in the vector of incident wave amplitudes (a) is calculated explicitly. This choice requires a matrix inversion when calculating the scattering matrix, but may lead to more accurate scattering parameters when there are reflections from simulation boundaries. \ns_param_def : Literal['pseudo', 'power'] = pseudo\n    Whether to compute scattering parameters using the 'pseudo' or 'power' wave definitions.\n\nNotes\n-----\n\n**References**\n\n.. [1]  R. B. Marks and D. F. Williams, \"A general waveguide circuit theory,\"\n        J. Res. Natl. Inst. Stand. Technol., vol. 97, pp. 533, 1992.\n\n.. [2]  D. M. Pozar, Microwave Engineering, 4th ed. Hoboken, NJ, USA:\n        John Wiley & Sons, 2012.",
+  "description": "Tool for modeling two-terminal multiport devices and computing port parameters\nwith lumped and wave ports.\n\nParameters\n----------\nattrs : dict = {}\n    Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, ``attrs`` are mutable. For example, the following is allowed for setting an ``attr`` ``obj.attrs['foo'] = bar``. Also note that `Tidy3D`` will raise a ``TypeError`` if ``attrs`` contain objects that can not be serialized. One can check if ``attrs`` are serializable by calling ``obj.json()``.\nsimulation : Simulation\n    Simulation describing the device without any sources present.\nports : Tuple[Union[LumpedPort, CoaxialLumpedPort, WavePort], ...] = ()\n    Collection of lumped and wave ports associated with the network. For each port, one simulation will be run with a source that is associated with the port.\nfreqs : Union[tuple[float, ...], ArrayLike[dtype=float, ndim=1]]\n    [units = Hz].  Array or list of frequencies at which to compute port parameters.\nremove_dc_component : bool = True\n    Whether to remove the DC component in the Gaussian pulse spectrum. If ``True``, the Gaussian pulse is modified at low frequencies to zero out the DC component, which is usually desirable so that the fields will decay. However, for broadband simulations, it may be better to have non-vanishing source power near zero frequency. Setting this to ``False`` results in an unmodified Gaussian pulse spectrum which can have a nonzero DC component.\nfolder_name : str = default\n    Name of the folder for the tasks on web.\nverbose : bool = False\n    Whether the :class:`.AbstractComponentModeler` should print status and progressbars.\ncallback_url : Optional[str] = None\n    Http PUT url to receive simulation finish event. The body content is a json file with fields ``{'id', 'status', 'name', 'workUnit', 'solverVersion'}``.\npath_dir : str = .\n    Base directory where data and batch will be downloaded.\nsolver_version : Optional[str] = None\n        batch_cached : Optional[Batch] = None\n    Optional field to specify ``batch``. Only used as a workaround internally so that ``batch`` is written when ``.to_file()`` and then the proper batch is loaded from ``.from_file()``. We recommend leaving unset as setting this field along with fields that were not used to create the task will cause errors.\nrun_only : Optional[Tuple[IndexType, ...]] = None\n    Set of matrix indices that define the simulations to run. If ``None``, simulations will be run for all indices in the scattering matrix. If a tuple is given, simulations will be run only for the given matrix indices.\nelement_mappings : Tuple[tuple[~ElementType, ~ElementType, Union[tidy3d.components.types.tidycomplex, tidy3d.components.types.ComplexNumber]], ...] = ()\n    Tuple of S matrix element mappings, each described by a tuple of (input_element, output_element, coefficient), where the coefficient is the element_mapping coefficient describing the relationship between the input and output matrix element. If all elements of a given column of the scattering matrix are defined by ``element_mappings``, the simulation corresponding to this column is skipped automatically.\nradiation_monitors : Tuple[DirectivityMonitor, ...] = ()\n    Facilitates the calculation of figures-of-merit for antennas. These monitor will be included in every simulation and record the radiated fields. \nassume_ideal_excitation : bool = False\n    If ``True``, only the excited port is assumed to have a nonzero incident wave amplitude power. This choice simplifies the calculation of the scattering matrix. If ``False``, every entry in the vector of incident wave amplitudes (a) is calculated explicitly. This choice requires a matrix inversion when calculating the scattering matrix, but may lead to more accurate scattering parameters when there are reflections from simulation boundaries. \ns_param_def : Literal['pseudo', 'power'] = pseudo\n    Whether to compute scattering parameters using the 'pseudo' or 'power' wave definitions.\n\nNotes\n-----\n\n**References**\n\n.. [1]  R. B. Marks and D. F. Williams, \"A general waveguide circuit theory,\"\n        J. Res. Natl. Inst. Stand. Technol., vol. 97, pp. 533, 1992.\n\n.. [2]  D. M. Pozar, Microwave Engineering, 4th ed. Hoboken, NJ, USA:\n        John Wiley & Sons, 2012.",
   "type": "object",
   "properties": {
     "attrs": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"title": "TerminalComponentModeler",`
`3`		- "description": "Tool for modeling two-terminal multiport devices and computing port parameters\nwith lumped and wave ports.\n\nParameters\n----------\nattrs : dict = {}\n Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, ``attrs`` are mutable. For example, the following is allowed for setting an ``attr`` ``obj.attrs['foo'] = bar``. Also note that `Tidy3D`` will raise a ``TypeError`` if ``attrs`` contain objects that can not be serialized. One can check if ``attrs`` are serializable by calling ``obj.json()``.\nsimulation : Simulation\n Simulation describing the device without any sources present.\nports : Tuple[Union[LumpedPort, CoaxialLumpedPort, WavePort], ...] = ()\n Collection of lumped and wave ports associated with the network. For each port, one simulation will be run with a source that is associated with the port.\nfreqs : Union[tuple[float, ...], ArrayLike[dtype=float, ndim=1]]\n [units = Hz]. Array or list of frequencies at which to compute port parameters.\nremove_dc_component : bool = True\n Whether to remove the DC component in the Gaussian pulse spectrum. If ``True``, the Gaussian pulse is modified at low frequencies to zero out the DC component, which is usually desirable so that the fields will decay. However, for broadband simulations, it may be better to have non-vanishing source power near zero frequency. Setting this to ``False`` results in an unmodified Gaussian pulse spectrum which can have a nonzero DC component.\nfolder_name : str = default\n Name of the folder for the tasks on web.\nverbose : bool = False\n Whether the :class:`.AbstractComponentModeler` should print status and progressbars.\ncallback_url : Optional[str] = None\n Http PUT url to receive simulation finish event. The body content is a json file with fields ``{'id', 'status', 'name', 'workUnit', 'solverVersion'}``.\npath_dir : str = .\n Base directory where data and batch will be downloaded.\nsolver_version : Optional[str] = None\n batch_cached : Optional[Batch] = None\n Optional field to specify ``batch``. Only used as a workaround internally so that ``batch`` is written when ``.to_file()`` and then the proper batch is loaded from ``.from_file()``. We recommend leaving unset as setting this field along with fields that were not used to create the task will cause errors.\nrun_only : Optional[Tuple[TypeVar, ...]] = None\n Set of matrix indices that define the simulations to run. If ``None``, simulations will be run for all indices in the scattering matrix. If a tuple is given, simulations will be run only for the given matrix indices.\nelement_mappings : Tuple[tuple[~ElementType, ~ElementType, Union[tidy3d.components.types.tidycomplex, tidy3d.components.types.ComplexNumber]], ...] = ()\n Tuple of S matrix element mappings, each described by a tuple of (input_element, output_element, coefficient), where the coefficient is the element_mapping coefficient describing the relationship between the input and output matrix element. If all elements of a given column of the scattering matrix are defined by ``element_mappings``, the simulation corresponding to this column is skipped automatically.\nradiation_monitors : Tuple[DirectivityMonitor, ...] = ()\n Facilitates the calculation of figures-of-merit for antennas. These monitor will be included in every simulation and record the radiated fields. \nassume_ideal_excitation : bool = False\n If ``True``, only the excited port is assumed to have a nonzero incident wave amplitude power. This choice simplifies the calculation of the scattering matrix. If ``False``, every entry in the vector of incident wave amplitudes (a) is calculated explicitly. This choice requires a matrix inversion when calculating the scattering matrix, but may lead to more accurate scattering parameters when there are reflections from simulation boundaries. \ns_param_def : Literal['pseudo', 'power'] = pseudo\n Whether to compute scattering parameters using the 'pseudo' or 'power' wave definitions.\n\nNotes\n-----\n\nReferences\n\n.. [1] R. B. Marks and D. F. Williams, \"A general waveguide circuit theory,\"\n J. Res. Natl. Inst. Stand. Technol., vol. 97, pp. 533, 1992.\n\n.. [2] D. M. Pozar, Microwave Engineering, 4th ed. Hoboken, NJ, USA:\n John Wiley & Sons, 2012.",
	`3`	+ "description": "Tool for modeling two-terminal multiport devices and computing port parameters\nwith lumped and wave ports.\n\nParameters\n----------\nattrs : dict = {}\n Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, ``attrs`` are mutable. For example, the following is allowed for setting an ``attr`` ``obj.attrs['foo'] = bar``. Also note that `Tidy3D`` will raise a ``TypeError`` if ``attrs`` contain objects that can not be serialized. One can check if ``attrs`` are serializable by calling ``obj.json()``.\nsimulation : Simulation\n Simulation describing the device without any sources present.\nports : Tuple[Union[LumpedPort, CoaxialLumpedPort, WavePort], ...] = ()\n Collection of lumped and wave ports associated with the network. For each port, one simulation will be run with a source that is associated with the port.\nfreqs : Union[tuple[float, ...], ArrayLike[dtype=float, ndim=1]]\n [units = Hz]. Array or list of frequencies at which to compute port parameters.\nremove_dc_component : bool = True\n Whether to remove the DC component in the Gaussian pulse spectrum. If ``True``, the Gaussian pulse is modified at low frequencies to zero out the DC component, which is usually desirable so that the fields will decay. However, for broadband simulations, it may be better to have non-vanishing source power near zero frequency. Setting this to ``False`` results in an unmodified Gaussian pulse spectrum which can have a nonzero DC component.\nfolder_name : str = default\n Name of the folder for the tasks on web.\nverbose : bool = False\n Whether the :class:`.AbstractComponentModeler` should print status and progressbars.\ncallback_url : Optional[str] = None\n Http PUT url to receive simulation finish event. The body content is a json file with fields ``{'id', 'status', 'name', 'workUnit', 'solverVersion'}``.\npath_dir : str = .\n Base directory where data and batch will be downloaded.\nsolver_version : Optional[str] = None\n batch_cached : Optional[Batch] = None\n Optional field to specify ``batch``. Only used as a workaround internally so that ``batch`` is written when ``.to_file()`` and then the proper batch is loaded from ``.from_file()``. We recommend leaving unset as setting this field along with fields that were not used to create the task will cause errors.\nrun_only : Optional[Tuple[IndexType, ...]] = None\n Set of matrix indices that define the simulations to run. If ``None``, simulations will be run for all indices in the scattering matrix. If a tuple is given, simulations will be run only for the given matrix indices.\nelement_mappings : Tuple[tuple[~ElementType, ~ElementType, Union[tidy3d.components.types.tidycomplex, tidy3d.components.types.ComplexNumber]], ...] = ()\n Tuple of S matrix element mappings, each described by a tuple of (input_element, output_element, coefficient), where the coefficient is the element_mapping coefficient describing the relationship between the input and output matrix element. If all elements of a given column of the scattering matrix are defined by ``element_mappings``, the simulation corresponding to this column is skipped automatically.\nradiation_monitors : Tuple[DirectivityMonitor, ...] = ()\n Facilitates the calculation of figures-of-merit for antennas. These monitor will be included in every simulation and record the radiated fields. \nassume_ideal_excitation : bool = False\n If ``True``, only the excited port is assumed to have a nonzero incident wave amplitude power. This choice simplifies the calculation of the scattering matrix. If ``False``, every entry in the vector of incident wave amplitudes (a) is calculated explicitly. This choice requires a matrix inversion when calculating the scattering matrix, but may lead to more accurate scattering parameters when there are reflections from simulation boundaries. \ns_param_def : Literal['pseudo', 'power'] = pseudo\n Whether to compute scattering parameters using the 'pseudo' or 'power' wave definitions.\n\nNotes\n-----\n\nReferences\n\n.. [1] R. B. Marks and D. F. Williams, \"A general waveguide circuit theory,\"\n J. Res. Natl. Inst. Stand. Technol., vol. 97, pp. 533, 1992.\n\n.. [2] D. M. Pozar, Microwave Engineering, 4th ed. Hoboken, NJ, USA:\n John Wiley & Sons, 2012.",
`4`	`4`	`"type": "object",`
`5`	`5`	`"properties": {`
`6`	`6`	`"attrs": {`