piel.models.frequency

Subpackages

• piel.models.frequency.electrical
• piel.models.frequency.electro_optic
  • piel.models.frequency.electro_optic.ideal
• piel.models.frequency.electronic
• piel.models.frequency.opto_electronic
• piel.models.frequency.photonic
  • piel.models.frequency.photonic.coupler_simple
  • piel.models.frequency.photonic.crossing_simple
  • piel.models.frequency.photonic.directional_coupler_length
  • piel.models.frequency.photonic.directional_coupler_real
  • piel.models.frequency.photonic.directional_coupler_simple
  • piel.models.frequency.photonic.grating_coupler
  • piel.models.frequency.photonic.mmi1x2
  • piel.models.frequency.photonic.mmi2x2
  • piel.models.frequency.photonic.straight_waveguide

Submodules

• piel.models.frequency.all
• piel.models.frequency.defaults
• piel.models.frequency.utils

Package Contents

Functions

compose_custom_model_library_from_defaults(→ dict)	Compose the default models with the custom models.
get_all_models(→ dict)	Returns the default models dictionary.
get_default_models(→ dict)	Returns the default models dictionary.

compose_custom_model_library_from_defaults(custom_models: dict) → dict

Compose the default models with the custom models.

Parameters:

custom_models (dict) – Custom models dictionary.

Returns:

Composed models dictionary.

Return type:

dict

get_all_models(custom_library: dict | None = None) → dict

Returns the default models dictionary.

Parameters:

custom_library (dict) – Custom defaults dictionary.

Returns:

Default models dictionary.

Return type:

dict

get_default_models(custom_defaults: dict | None = None, type: Literal[classical, quantum, optical_logic_verification] = 'classical') → dict

Returns the default models dictionary.

Parameters:

• custom_defaults (dict) – Custom defaults dictionary.

• type (Literal["default", "quantum"]) – Type of default models dictionary to return.

Returns:

Default models dictionary.

Return type:

dict