r"""The diamater of the Earth-stationed antenna, used for scintillation loss See section 6.6.6 of 38.811 specification.

r"""Direction of communication. Either "uplink" or "downlink".

r""" Distance between each UT and each BS in the X-Y plan [m]. [batch size, number of BSs, number of UTs]

r"""Indoor distance between each UT and BS in the X-Y plan [m], i.e., part of the total distance that corresponds to indoor propagation in the

r"""Outdoor distance between each UT and BS in the X-Y plan [m], i.e., part of the total distance that corresponds to outdoor propagation in

r""" Distance between each UT and each BS [m]. [batch size, number of BSs, number of UTs]

r"""Indoor distance between each UT and BS [m], i.e., part of the total distance that corresponds to indoor propagation. Set to 0 for

r"""Outdoor distance between each UT and BS [m], i.e., part of the total distance that corresponds to outdoor propagation. Equals to `

r"""Efficiency of the Earth-stationed antenna, used for scintillation loss, 0.5 is conservative estimate See section 6.6.6 of 38.811 specifica

Horizontal spacing between the antenna elements within a panel [multiple of wavelength]

Vertical spacing between the antenna elements within a panel [multiple of wavelength]

r"""Elevation angle of the LOS path of the satellite/HAPS vs. ground horizon in degrees

r"""elevation_angle in degrees

r"""Basic pathloss component [dB]. See section 7.4.1 of 38.901 specification. [batch size, num BS, num UT]

r"""Generate exponential correlation matrices. This function computes for every element :math:`a` of a complex-valued tensor :math:`\mathbf{a

r"""Free Space Pathloss, which is a part of the pathloss component [dB]. See section 7.4.1 of 38.901 specification. This variable is only used

r"""Basic pathloss component [dB]. See section 7.4.1 of 38.901 specification. [batch size, num BS, num UT]

r""" Generate a batch of topologies consisting of a single BS located at the origin and ``num_ut`` UTs randomly and uniformly dropped in a cel

r""" Generate a batch of topologies consisting of a single BS located at the origin, ``num_ut`` UTs randomly and uniformly dropped in a cell s

r"""Heigh of BSs [m].[batch size, number of BSs]

r"""Heigh of UTs [m]. [batch size, number of UTs]

Vertical spacing between elements [multiple of wavelength]

r""" Indoor state of UTs. `True` is indoor, `False` otherwise. [batch size, number of UTs]

r"""K-factor in linear scale. Only available with LoS models.

r"""K-factor in linear scale. Only available with LoS models.

r"""Wavelength [m]

r"""Latitude of each UT, used for additional pathlosses See section 6.6.6 of 38.811 specification.

r"""LoS state of BS-UT links. `True` if LoS, `False` otherwise. [batch size, number of BSs, number of UTs]

r"""`True` is this is a LoS model. `False` otherwise.

r"""`True` if this is a LoS model. `False` otherwise.

r"""LoS azimuth angle of arrival of each BS-UT link [deg]. [batch size, number of BSs, number of UTs]

r"""LoS azimuth angle of departure of each BS-UT link [deg]. [batch size, number of BSs, number of UTs]

r""" Path of the configuration file for LoS scenario

r""" Path of the configuration file for LoS scenario

r""" Path of the configuration file for LoS scenario

r""" Path of the configuration file for LoS scenario

r"""Probability of each UT to be LoS. Used to randomly generate LoS status of outdoor UTs. [batch size, number of UTs]

r"""Probability of each UT to be LoS. Used to generate LoS status of outdoor UTs. Taken from table 6.6.1-1 in TR38.811 [batch

r"""Probability of each UT to be LoS. Used to generate LoS status of outdoor UTs. Taken from table 6.6.1-1 in TR38.811 [batc

r"""Probability of each UT to be LoS. Used to generate LoS status of outdoor UTs. Taken from table 6.6.1-1 in TR38.811 [batc

r"""considered 90 degrees

r"""LoS zenith angle of departure of each BS-UT link [deg]. [batch size, number of BSs, number of UTs]

r""" Mean of LSPs in the log domain. [batch size, number of BSs, number of UTs, 7]. The last dimension corresponds to the LSPs

r""" STD of LSPs in the log domain. [batch size, number of BSs, number of UTs, 7]. The last dimension corresponds to the LSPs,

r"""Liquid water content in kg/m^2, used for cloud attenuation See section 6.6.5 of 38.811 specification.

r"""Distance between all pairs for UTs in the X-Y plan [m]. [batch size, number of UTs, number of UTs]

r"""Maximum indoor 2D distance for indoor UTs [m]

r"""Maximum indoor 2D distance for indoor UTs [m]

r"""Maximum indoor 2D distance for indoor UTs [m]

r"""Maximum indoor 2D distance for indoor UTs [m]

r"""LoS component power in linear scale. Only available with LoS models.

r"""Path powers in linear scale

r"""Minimum indoor 2D distance for indoor UTs [m]

r"""Minimum indoor 2D distance for indoor UTs [m]

r"""Minimum indoor 2D distance for indoor UTs [m]

r"""Minimum indoor 2D distance for indoor UTs [m]

r""" Path of the configuration file for NLoS scenario

r""" Path of the configuration file for NLoS scenario

r""" Path of the configuration file for NLoS scenario

r""" Path of the configuration file for NLoS scenario

Total number of antenna elements

Number of BSs.

r"""Number of paths (:math:`M`)

r"""Number of paths (:math:`M`)

r"""Number of clusters for LoS scenario

r"""Maximum number of clusters over LoS and NLoS scenarios

r"""Number of clusters for NLoS scenario

Number of columns

Number of columns of panels

Number of columns of elements per panel

Number of panels

Number of antenna elements per panel

Number of rows

Number of rows of panels

Number of rows of elements per panel

Number of UTs.

r"""Generate covariance matrices from the one-ring model. This function generates approximate covariance matrices for the so-called `one-ring

Horizontal spacing between the panels [multiple of wavelength]

Vertical spacing between the panels [multiple of wavelength]

r"""`True` is pathloss is enabled. `False` otherwise.

Polarization ("single" or "dual")

Polarization type. "V" or "H" for single polarization. "VH" or "cross" for dual polarization.

Polarization ("single" or "dual")

r"""Path powers in linear scale

r"""Rain rate in mm/h, used for rain attenuation See section 6.6.5 of 38.811 specification.

r"""Number of rays per cluster

r"""Number of rays per cluster

r"""Number of rays per cluster

r"""Number of rays per cluster

r"""Relative humidity in percent, used for gas loss See section 6.6.4 of 38.811 specification.

Reference implementation: Rotate according to an orientation

r"""Basic pathloss component [dB]. See section 7.4.1 of 38.901 specification. [batch size, num BS, num UT]