`SimulationSetups`#

class pyedb.grpc.database.simulation_setups.SimulationSetups(pedb)#: Simulation setups container class.

Overview#

Methods

`create`	Add HFSS analysis setup.
`create_hfss_setup`	Add HFSS analysis setup.
`create_siwave_setup`	Add SIWave analysis setup.
`create_siwave_dcir_setup`	Add SIWave DCIR analysis setup.
`create_siwave_cpa_setup`	Add SIWave CPA analysis setup.
`create_raptor_x_setup`	Add RaptorX analysis setup
`create_q3d_setup`	Add Q3D analysis setup

Properties

`hfss`	HFSS simulation setups.
`siwave`	SIWave simulation setups.
`siwave_dcir`	SIWave DCIR simulation setups.
`siwave_cpa`	SIWave CPA simulation setups.
`raptorx`	RaptorX simulation setups.
`q3d`	Q3D simulation setups.
`setups`	All simulation setups.

Import detail#

from pyedb.grpc.database.simulation_setups import SimulationSetups

Property detail#

property SimulationSetups.hfss: dict[str, pyedb.grpc.database.simulation_setup.hfss_simulation_setup.HfssSimulationSetup]#

HFSS simulation setups.

Returns:

List[:class:`HFSSSimulationSetup
hfss_simulation_setup.HFSSSimulationSetup>`]

property SimulationSetups.siwave: dict[str, pyedb.grpc.database.simulation_setup.siwave_simulation_setup.SiwaveSimulationSetup]#

SIWave simulation setups.

Returns:

List[:class:`SIWaveSimulationSetup
siwave_simulation_setup.SIWaveSimulationSetup>`]

property SimulationSetups.siwave_dcir: dict[str, pyedb.grpc.database.simulation_setup.siwave_dcir_simulation_setup.SIWaveDCIRSimulationSetup]#

SIWave DCIR simulation setups.

Returns:

List[:class:`SIWaveDCIRSimulationSetup
siwave_dcir_simulation_setup.SIWaveDCIRSimulationSetup>`]

property SimulationSetups.siwave_cpa: dict[str, pyedb.grpc.database.simulation_setup.siwave_cpa_simulation_setup.SIWaveCPASimulationSetup]#

SIWave CPA simulation setups.

Returns:

List[:class:`SIWaveCPASimulationSetup
siwave_cpa_simulation_setup.SIWaveCPASimulationSetup>`]

property SimulationSetups.raptorx: dict[str, pyedb.grpc.database.simulation_setup.raptor_x_simulation_setup.RaptorXSimulationSetup]#

RaptorX simulation setups.

Returns:

List[:class:`RaptorXSimulationSetup
raptor_x_simulation_setup.RaptorXSimulationSetup>`]

property SimulationSetups.q3d: dict[str, pyedb.grpc.database.simulation_setup.q3d_simulation_setup.Q3DSimulationSetup]#

Q3D simulation setups.

Returns:

List[:class:`Q3DSimulationSetup
q3d_simulation_setup.Q3DSimulationSetup>`]

property SimulationSetups.setups: dict[str, object]#

All simulation setups.

Returns:

dict[str:setup name, :class:`SimulationSetup
simulation_setup.SimulationSetup>`]

Method detail#

SimulationSetups.create(name=None, solver='hfss', distribution='linear', start_freq=0, stop_freq=20000000000.0, step_freq=1000000.0, discrete_sweep=False, sweep_name: str = 'frequency_sweep', **kwargs) → pyedb.grpc.database.simulation_setup.simulation_setup.SimulationSetup | None#

Add HFSS analysis setup.

Parameters:

namestr, optional: Setup name (auto-generated if None).
solverstr, optional: Simulation setup type (“hfss”, “siwave”, “siwave_dcir”, “raptor_x”, “q3d”).
distributionstr, optional: Sweep distribution type (“linear”, “linear_count”, “decade_count”, “octave_count”, “exponential”).
start_freqfloat, str, optional: Starting frequency (Hz).
stop_freqfloat, str, optional: Stopping frequency (Hz).
step_freqfloat, str, int, optional: Frequency step (Hz) or count depending on distribution.
discrete_sweepbool, optional: Use discrete sweep.
sweep_namestr, optional: Name of the frequency sweep.

Returns:

HfssSimulationSetup: Created setup object.

Examples

from pyedb import Edb

edb = Edb("my_aedb")
hfss_setup = edb.simulation_setups.create(
    name="MySetup",
    solver="hfss",
    distribution="linear_count",
    start_freq=1e9,
    stop_freq=10e9,
    step_freq=100,
    discrete_sweep=False,
    sweep_name="MyFrequencySweep",
)

SimulationSetups.create_hfss_setup(name=None, distribution='linear', start_freq: float = None, stop_freq: float = None, step_freq: float = None, discrete_sweep=False, sweep_name: str = 'frequency_sweep', **kwargs) → pyedb.grpc.database.simulation_setup.hfss_simulation_setup.HfssSimulationSetup#

Add HFSS analysis setup.

Parameters:

namestr, optional: Setup name (auto-generated if None).
distributionstr, optional: Sweep distribution type (“linear”, “linear_count”, “decade_count”, “octave_count”, “exponential”).
start_freqfloat, str, optional: Starting frequency (Hz).
stop_freqfloat, str, optional: Stopping frequency (Hz).
step_freqfloat, str, int, optional
Frequency step (Hz) or count depending on distribution.
discrete_sweepbool, optional: Use discrete sweep.
sweep_namestr, optional: Name of the frequency sweep.

Returns:

HfssSimulationSetup: Created setup object.

SimulationSetups.create_siwave_setup(name=None, distribution='linear', start_freq: float = None, stop_freq: float = None, step_freq: float = None, discrete_sweep=False, sweep_name: str = 'frequency_sweep', **kwargs) → pyedb.grpc.database.simulation_setup.siwave_simulation_setup.SiwaveSimulationSetup#

Add SIWave analysis setup.

Parameters:

namestr, optional: Setup name (auto-generated if None).
distributionstr, optional: Sweep distribution type (“linear”, “linear_count”, “decade_count”, “octave_count”, “exponential”).
start_freqfloat, str, optional: Starting frequency (Hz).
stop_freqfloat, str, optional: Stopping frequency (Hz).
step_freqfloat, str, int, optional: Frequency step (Hz) or count depending on distribution.
discrete_sweepbool, optional: Use discrete sweep.
sweep_namestr, optional: Name of the frequency sweep.

Returns:

SIWaveSimulationSetup: Created setup object.

SimulationSetups.create_siwave_dcir_setup(name=None, **kwargs) → pyedb.grpc.database.simulation_setup.siwave_dcir_simulation_setup.SIWaveDCIRSimulationSetup#

Add SIWave DCIR analysis setup.

Parameters:

namestr, optional: Setup name (auto-generated if None).

Returns:

SIWaveDCIRSimulationSetup: Created setup object.

SimulationSetups.create_siwave_cpa_setup(name=None, siwave_cpa_config=None, **kwargs) → pyedb.grpc.database.simulation_setup.siwave_cpa_simulation_setup.SIWaveCPASimulationSetup#

Add SIWave CPA analysis setup.

Parameters:

namestr, optional: Setup name (auto-generated if None).

Returns:

SIWaveCPASimulationSetup: Created setup object.

SimulationSetups.create_raptor_x_setup(name=None, distribution='linear', start_freq: float = None, stop_freq: float = None, step_freq: float = None, discrete_sweep=False, sweep_name: str = 'frequency_sweep', **kwargs) → pyedb.grpc.database.simulation_setup.raptor_x_simulation_setup.RaptorXSimulationSetup#

Add RaptorX analysis setup Parameters ———- name : str, optional

Setup name (auto-generated if None).

distributionstr, optional: Sweep distribution type (“linear”, “linear_count”, “decade_count”, “octave_count”, “exponential”).
start_freqfloat, str, optional: Starting frequency (Hz).
stop_freqfloat, str, optional: Stopping frequency (Hz).
step_freqfloat, str, int, optional: Frequency step (Hz) or count depending on distribution.
discrete_sweepbool, optional: Use discrete sweep.
sweep_namestr, optional: Name of the frequency sweep.

Returns#

RaptorXSimulationSetup: Created setup object.

SimulationSetups.create_q3d_setup(name=None, distribution='linear', start_freq: float = None, stop_freq: float = None, step_freq: float = None, discrete_sweep=False, sweep_name: str = 'frequency_sweep', **kwargs) → pyedb.grpc.database.simulation_setup.q3d_simulation_setup.Q3DSimulationSetup#

Add Q3D analysis setup Parameters ———- name : str, optional

Setup name (auto-generated if None).

distributionstr, optional: Sweep distribution type (“linear”, “linear_count”, “decade_count”, “octave_count”, “exponential”).
start_freqfloat, str, optional: Starting frequency (Hz).
stop_freqfloat, str, optional: Stopping frequency (Hz).
step_freqfloat, str, int, optional: Frequency step (Hz) or count depending on distribution.
discrete_sweepbool, optional: Use discrete sweep.
sweep_namestr, optional: Name of the frequency sweep.

Returns#

Q3DSimulationSetup: Created setup object.

SimulationSetups#

Overview#

Import detail#

Property detail#

Method detail#

Returns#

Returns#

`SimulationSetups`#