Release v1.0.1

profile/P619/detailed_profile_p619.py

@@ -19,21 +19,19 @@
 
 # Constants
 frequency_MHz = 2680.0
-space_station_alt_m = 35786.0 * 1000  # Geostationary orbit altitude in meters
 earth_station_alt_m = 1000.0
 earth_station_lat_deg = -15.7801
-earth_station_long_diff_deg = 0.0  # Not used in the loss calculation
 season = "SUMMER"
 apparent_elevation = np.arange(0, 90)  # Elevation angles from 0 to 90 degrees
 surf_water_vapour_density = 2.5
 
 # Initialize the propagation model
 random_number_gen = np.random.RandomState(101)
 propagation = PropagationP619(random_number_gen=random_number_gen,
-                              space_station_alt_m=space_station_alt_m,
                               earth_station_alt_m=earth_station_alt_m,
                               earth_station_lat_deg=earth_station_lat_deg,
-                              earth_station_long_diff_deg=earth_station_long_diff_deg,
+                              mean_clutter_height='low',
+                              below_rooftop=0.0,
                               season=season)
 
 

profile/P619/profile_with_and_without_lookuptable_p619.py

@@ -16,7 +16,6 @@
 
 # Constants
 frequency_MHz = 2680.0
-space_station_alt_m = 35786.0 * 1000  # Geostationary orbit altitude in meters
 earth_station_alt_m = 1000.0
 earth_station_lat_deg = -15.7801
 earth_station_long_diff_deg = 0.0  # Not used in the loss calculation
@@ -27,10 +26,10 @@
 # Initialize the propagation model
 random_number_gen = np.random.RandomState(101)
 propagation = PropagationP619(random_number_gen=random_number_gen,
-                              space_station_alt_m=space_station_alt_m,
                               earth_station_alt_m=earth_station_alt_m,
                               earth_station_lat_deg=earth_station_lat_deg,
-                              earth_station_long_diff_deg=earth_station_long_diff_deg,
+                              mean_clutter_height='low',
+                              below_rooftop=0.0,
                               season=season)
 
 # Profile with lookup table

requirements.txt

@@ -46,14 +46,14 @@ mpmath==1.3.0
 multipledispatch==1.0.0
 nest-asyncio==1.6.0
 numpy==1.26.4
-obspy==1.4.0
+#obspy==1.4.0
 overloading==0.5.0
 packaging==23.2
-pandas==2.2.1
+pandas==2.3.1
 parso==0.8.4
 pep8==1.7.1
 pexpect==4.9.0
-pillow==10.2.0
+pillow==11.3.0
 pip-system-certs==4.0
 platformdirs==4.2.0
 plotly==5.23.0
@@ -80,9 +80,9 @@ PyYAML==6.0.1
 pyzmq==26.0.3
 requests==2.31.0
 ruff==0.6.9
-scipy==1.12.0
+scipy==1.16.1
 setuptools==69.1.1
-shapely==2.0.3
+shapely==2.1.1
 six==1.16.0
 snowballstemmer==2.2.0
 SQLAlchemy==2.0.29

sharc/antenna/antenna_beamforming_imt.py

@@ -14,8 +14,7 @@
 from sharc.antenna.antenna_element_imt_const import AntennaElementImtConst
 from sharc.antenna.antenna_subarray_imt import AntennaSubarrayIMT
 from sharc.antenna.antenna import Antenna
-from sharc.support.named_tuples import AntennaPar
-from sharc.parameters.imt.parameters_antenna_imt import ParametersAntennaImt, ParametersAntennaSubarrayImt
+from sharc.parameters.imt.parameters_antenna_imt import ParametersAntennaImt
 
 
 class AntennaBeamformingImt(Antenna):
@@ -45,19 +44,17 @@ class AntennaBeamformingImt(Antenna):
 
     def __init__(
             self,
-            par: AntennaPar,
+            par: ParametersAntennaImt,
             azimuth: float,
-            elevation: float,
-            subarray: ParametersAntennaSubarrayImt = ParametersAntennaSubarrayImt(
-            is_enabled=False)):
+            elevation: float):
         """
         Constructs an AntennaBeamformingImt object.
         Does not receive angles in local coordinate system.
         Elevation taken with x axis as reference.
 
         Parameters
         ---------
-            param (AntennaPar): antenna IMT parameters
+            param (ParametersAntennaImt): antenna IMT parameters
             azimuth (float): antenna's physical azimuth inclination
             elevation (float): antenna's physical elevation inclination
                 referenced in the x axis
@@ -78,12 +75,12 @@ def __init__(
                     par.element_pattern} not supported", )
             sys.exit(1)
 
-        if subarray.is_enabled:
+        if par.subarray.is_enabled:
             self.subarray = AntennaSubarrayIMT(
                 element=self.element,
-                eletrical_downtilt=subarray.eletrical_downtilt,
-                n_rows=subarray.n_rows,
-                element_vert_spacing=subarray.element_vert_spacing
+                eletrical_downtilt=par.subarray.eletrical_downtilt,
+                n_rows=par.subarray.n_rows,
+                element_vert_spacing=par.subarray.element_vert_spacing
             )
 
         self.azimuth = azimuth

sharc/antenna/antenna_element_imt_const.py

@@ -6,7 +6,7 @@
 """
 
 
-from sharc.support.named_tuples import AntennaPar
+from sharc.parameters.imt.parameters_antenna_imt import ParametersAntennaImt
 import numpy as np
 
 
@@ -20,7 +20,7 @@ class AntennaElementImtConst(object):
 
     """
 
-    def __init__(self, par: AntennaPar):
+    def __init__(self, par: ParametersAntennaImt):
         """
         Constructs an AntennaElementImt object.
 

sharc/antenna/antenna_element_imt_f1336.py

@@ -8,7 +8,7 @@
 import numpy as np
 import sys
 
-from sharc.support.named_tuples import AntennaPar
+from sharc.parameters.imt.parameters_antenna_imt import ParametersAntennaImt
 
 
 class AntennaElementImtF1336(object):
@@ -23,7 +23,7 @@ class AntennaElementImtF1336(object):
         phi_3db (float): horizontal 3dB beamwidth of single element [degrees]
     """
 
-    def __init__(self, par: AntennaPar):
+    def __init__(self, par: ParametersAntennaImt):
         """
         Constructs an AntennaElementImt object.
 

sharc/antenna/antenna_element_imt_m2101.py

@@ -7,7 +7,7 @@
 
 import numpy as np
 
-from sharc.support.named_tuples import AntennaPar
+from sharc.parameters.imt.parameters_antenna_imt import ParametersAntennaImt
 
 
 class AntennaElementImtM2101(object):
@@ -23,7 +23,7 @@ class AntennaElementImtM2101(object):
         sla_v (float): element vertical sidelobe attenuation
     """
 
-    def __init__(self, par: AntennaPar):
+    def __init__(self, par: ParametersAntennaImt):
         """
         Constructs an AntennaElementImt object.
 

sharc/antenna/antenna_factory.py

@@ -1,9 +1,11 @@
 
 """Antenna factory module for creating antenna instances based on parameters."""
 from sharc.parameters.parameters_antenna import ParametersAntenna
+from sharc.antenna.antenna import Antenna
 
 from sharc.antenna.antenna_mss_adjacent import AntennaMSSAdjacent
 from sharc.antenna.antenna_omni import AntennaOmni
+from sharc.antenna.antenna_mss_hibleo_x_ue import AntennaMssHibleoXUe
 from sharc.antenna.antenna_f699 import AntennaF699
 from sharc.antenna.antenna_s465 import AntennaS465
 from sharc.antenna.antenna_rra7_3 import AntennaReg_RR_A7_3
@@ -13,6 +15,8 @@
 from sharc.antenna.antenna_s1528 import AntennaS1528, AntennaS1528Leo, AntennaS1528Taylor
 from sharc.antenna.antenna_beamforming_imt import AntennaBeamformingImt
 
+import numpy as np
+
 
 class AntennaFactory():
     """Factory class for creating antenna instances based on pattern parameters."""
@@ -27,6 +31,8 @@ def create_antenna(
         match antenna_params.pattern:
             case "OMNI":
                 return AntennaOmni(antenna_params.gain)
+            case "HibleoX":
+                return AntennaMssHibleoXUe(antenna_params.hibleo_x.frequency)
             case "ITU-R F.699":
                 return AntennaF699(antenna_params.itu_r_f_699)
             case "ITU-R-S.1528-Taylor":
@@ -58,3 +64,35 @@ def create_antenna(
                 raise ValueError(
                     f"Antenna factory does not support pattern {
                         antenna_params.pattern}")
+
+    @staticmethod
+    def create_n_antennas(
+        antenna_params: ParametersAntenna,
+        azimuth: np.ndarray | float,
+        elevation: np.ndarray | float,
+        n_stations: int,
+    ):
+        """
+        Creates many antennas based on passed parameters.
+        If antenna does not require each object to have different state,
+        only a single antenna object will be created, and every position
+        in the array will point to it.
+        This is much more performant.
+        """
+        antennas = np.empty((n_stations,), dtype=Antenna)
+        assert n_stations == len(azimuth)
+        assert n_stations == len(elevation)
+
+        if antenna_params.pattern == "ARRAY":
+            for i in range(n_stations):
+                antennas[i] = AntennaFactory.create_antenna(
+                    antenna_params, azimuth[i], elevation[i],
+                )
+        else:
+            # some antennas don't need azimuth and elevation at all
+            # this makes it much faster
+            antennas[:] = AntennaFactory.create_antenna(
+                antenna_params, None, None,
+            )
+
+        return antennas

sharc/antenna/antenna_mss_adjacent.py

@@ -43,9 +43,10 @@ def calculate_gain(self, *args, **kwargs) -> np.array:
         np.array
             Calculated antenna gain values.
         """
-        theta = np.absolute(kwargs["off_axis_angle_vec"])
+        theta_rad = np.deg2rad(np.absolute(kwargs["off_axis_angle_vec"]))
+        theta_rad = np.minimum(theta_rad, np.pi / 2 - 1e-4)
         return 20 * np.log10(self.frequency / 2e3) + 10 * \
-            np.log10(np.cos(np.deg2rad(theta)))
+            np.log10(np.cos(theta_rad))
 
 
 if __name__ == '__main__':

sharc/antenna/antenna_mss_hibleo_x_ue.py

@@ -0,0 +1,128 @@
+
+# -*- coding: utf-8 -*-
+"""Antenna model for HibleoX MSS UE in the 2.5GHz frequency band."""
+from sharc.antenna.antenna import Antenna
+
+import numpy as np
+
+# The filing does not provide an antenna model, but a set of points.
+# We interpolate these points to create a continuous function.
+# The points are taken from the filing.
+data_str = """
+x, y
+0, 2.7
+10, 2.6566311598597308
+20, 2.431925804835606
+30, 2.150602473172147
+40, 1.6546431302238513
+50, 0.9929370896722656
+60, 0.0904942389326866
+70, -0.9031468347087825
+80, -2.386785139873968
+90, -3.679459224299312
+"""
+
+HALF_BEAM_WIDTH_DEG = 64.0
+
+
+class AntennaMssHibleoXUe(Antenna):
+    """
+    Implements the MSS UE antenna pattern provided for the HIBLEO-X system in it's filings.
+
+    This is provided as a reference antenna pattern in document Document 4C/166-E - 30 September 2024.
+    This is valid only for frequencies around 2.45 GHz.
+    """
+
+    def __init__(self, frequency_MHz: float):
+        """
+        Initialize the AntennaMSSAdjacent class.
+
+        Parameters
+        ----------
+        frequency_MHz : float
+            Frequency in MHz for the antenna model.
+        """
+        super().__init__()
+        if frequency_MHz < 2483 or frequency_MHz > 2500:
+            raise ValueError("This antenna model is only valid for frequencies around 2.45 GHz")
+        self.frequency = frequency_MHz
+
+        # Parse the data string to extract x and y values
+        lines = data_str.strip().split('\n')[1:]
+        self.pattern_theta_deg = np.array([float(line.split(',')[0]) for line in lines])
+        self.patten_gain_dbi = np.array([float(line.split(',')[1]) for line in lines])
+
+    def calculate_gain(self, *args, **kwargs) -> np.array:
+        """
+        Calculate the antenna gain for the given off-axis angles.
+
+        Parameters
+        ----------
+        *args : tuple
+            Positional arguments (not used).
+        **kwargs : dict
+            Keyword arguments, expects 'off_axis_angle_vec' in degrees as input.
+
+        Returns
+        -------
+        np.array
+            Calculated antenna gain values.
+        """
+        theta_deg = kwargs["off_axis_angle_vec"]
+        return -2.5226404 * (np.deg2rad(theta_deg) ** 2) + 2.7
+
+
+if __name__ == '__main__':
+    import plotly.graph_objects as go
+    from scipy.optimize import curve_fit
+
+    # Compare the fitted parabolic function to the provided points
+
+    mss_ue_antenna = AntennaMssHibleoXUe(2483)
+
+    # Define the custom parabolic function without the linear term
+    def poly_no_linear(x, a):
+        """
+        Polynomial function of the form ax^2 + c (no linear term).
+        """
+        return a * x**2 + np.max(mss_ue_antenna.patten_gain_dbi)
+
+    # Fit the data using curve_fit
+    # initial_guess = [1, 1] # Optional: provide an initial guess for the parameters
+    params, covariance = curve_fit(
+        poly_no_linear,
+        np.deg2rad(mss_ue_antenna.pattern_theta_deg),
+        mss_ue_antenna.patten_gain_dbi
+    )
+
+    print("Fitting parabolic function (no linear term) to the provided points:")
+    print(f"Fitted parameters:\na={params}")
+    print(f"Covariance matrix:\n{covariance}")
+
+    off_axis_vec_deg = np.linspace(-90, 90, 100)
+    gains = mss_ue_antenna.calculate_gain(off_axis_angle_vec=off_axis_vec_deg)
+
+    gains_interp = np.interp(
+        np.abs(off_axis_vec_deg),
+        mss_ue_antenna.pattern_theta_deg,
+        mss_ue_antenna.patten_gain_dbi
+    )
+
+    fig = go.Figure(data=go.Scatter(x=off_axis_vec_deg, y=gains, mode='markers+lines', name='Parabolic Fit pattern'))
+    fig.update_layout(
+        title='Hibleo-X UE pattern from filing',
+        xaxis_title='off-axis angle (degrees)',
+        yaxis_title='Gain (dBi)',
+        template="plotly_white"
+    )
+    fig.update_yaxes(
+        linewidth=1,
+        linecolor='black',
+        mirror=True,
+        ticks='inside',
+        showline=True,
+        gridcolor="#DCDCDC",
+        gridwidth=1.5,
+    )
+    fig.add_trace(go.Scatter(x=off_axis_vec_deg, y=gains_interp, mode='markers', name='Interpolated'))
+    fig.show()