pyBADA 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

pyBADA/TCL.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Trajectory Computation Light (TCL) for BADAH/BADAE/BADA3/BADA4 aircraft performance module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 import os
@@ -96,13 +93,12 @@ def constantSpeedLevel(
     :param magneticDeclinationGrid: Optional magnetic declination grid to correct headings. Default is None.
     :param kwargs: Additional optional parameters:
 
-        - mass_const: Boolean. If True, keeps the aircraft mass constant during the segment. Default is False.
         - SOC_init: Initial battery state of charge for electric aircraft [%]. Default is 100 for BADAE.
         - speedBrakes: Dictionary defining whether speed brakes are deployed and their drag coefficient {deployed: False, value: 0.03}.
         - ROCD_min: Minimum rate of climb/descent threshold to identify service ceiling [ft/min]. Default varies by aircraft type.
         - config: Default aerodynamic configuration. Values: TO, IC, CR, AP, LD.
         - HpStep: Altitude step for step climb [ft]. Default is 2000 ft.
-        - m_iter: Number of iterations for mass integration. Default is 1 for BADAE, 2 for others.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - step_length: The step length for each iteration in [NM] or [s], depending on the lengthType. Default is 100 NM for BADA3/4 and 10 NM for BADAH/BADAE.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -190,7 +186,12 @@ def constantSpeedLevel(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -1166,6 +1167,7 @@ def constantSpeedLevel(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -1228,7 +1230,7 @@ def constantSpeedROCD(
         - speedBrakes: Dictionary specifying whether speed brakes are deployed and their drag coefficient {deployed: False, value: 0.03}.
         - ROCD_min: Minimum ROCD to identify the service ceiling [ft/min]. Default varies by aircraft type.
         - config: Default aerodynamic configuration. Values: TO, IC, CR, AP, LD. Default is None.
-        - mass_const: Boolean specifying whether to keep the mass constant during the segment. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for the mass integration loop. Default is 5.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -1317,7 +1319,12 @@ def constantSpeedROCD(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -1479,6 +1486,25 @@ def constantSpeedROCD(
         )
 
         # aircraft speed
+        if calculationType == "POINT" and AC.BADAFamily.BADAH:
+            [
+                Pav_POINT,
+                Peng_POINT,
+                Preq_POINT,
+                tas_POINT,
+                ROCD_POINT,
+                ESF_POINT,
+                limitation_POINT,
+            ] = AC.ARPM.ARPMProcedure(
+                phase=phase,
+                h=H_m,
+                DeltaTemp=DeltaTemp,
+                mass=mass[-1],
+                rating="ARPM",
+            )
+            v = conv.ms2kt(tas_POINT)
+            speedType = "TAS"
+
         [M_i, CAS_i, TAS_i] = atm.convertSpeed(
             v=v, speedType=speedType, theta=theta, delta=delta, sigma=sigma
         )
@@ -2180,6 +2206,7 @@ def constantSpeedROCD(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -2242,7 +2269,7 @@ def constantSpeedROCD_time(
         - speedBrakes: Dictionary specifying whether speed brakes are deployed and their drag coefficient {deployed: False, value: 0.03}.
         - ROCD_min: Minimum ROCD to identify the service ceiling [ft/min]. Default varies by aircraft type.
         - config: Default aerodynamic configuration. Values: TO, IC, CR, AP, LD. Default is None.
-        - mass_const: Boolean specifying whether to keep the mass constant during the segment. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for the mass integration loop. Default is 5.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -2326,7 +2353,12 @@ def constantSpeedROCD_time(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -2482,6 +2514,25 @@ def constantSpeedROCD_time(
             )
 
             # aircraft speed
+            if calculationType == "POINT" and AC.BADAFamily.BADAH:
+                [
+                    Pav_POINT,
+                    Peng_POINT,
+                    Preq_POINT,
+                    tas_POINT,
+                    ROCD_POINT,
+                    ESF_POINT,
+                    limitation_POINT,
+                ] = AC.ARPM.ARPMProcedure(
+                    phase=phase,
+                    h=H_m,
+                    DeltaTemp=DeltaTemp,
+                    mass=mass[-1],
+                    rating="ARPM",
+                )
+                v = conv.ms2kt(tas_POINT)
+                speedType = "TAS"
+
             [M_i, CAS_i, TAS_i] = atm.convertSpeed(
                 v=v, speedType=speedType, theta=theta, delta=delta, sigma=sigma
             )
@@ -3172,6 +3223,7 @@ def constantSpeedROCD_time(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -3233,7 +3285,7 @@ def constantSpeedSlope(
         - speedBrakes: A dictionary specifying whether speed brakes are deployed and the additional drag coefficient {deployed: False, value: 0.03}.
         - ROCD_min: Minimum rate of climb/descent used to determine service ceiling [ft/min]. Default varies based on aircraft type.
         - config: Default aerodynamic configuration (TO, IC, CR, AP, LD). Default is None.
-        - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for the mass integration loop. Default is 5.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -3317,7 +3369,12 @@ def constantSpeedSlope(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -3473,6 +3530,25 @@ def constantSpeedSlope(
         )
 
         # aircraft speed
+        if calculationType == "POINT" and AC.BADAFamily.BADAH:
+            [
+                Pav_POINT,
+                Peng_POINT,
+                Preq_POINT,
+                tas_POINT,
+                ROCD_POINT,
+                ESF_POINT,
+                limitation_POINT,
+            ] = AC.ARPM.ARPMProcedure(
+                phase=phase,
+                h=H_m,
+                DeltaTemp=DeltaTemp,
+                mass=mass[-1],
+                rating="ARPM",
+            )
+            v = conv.ms2kt(tas_POINT)
+            speedType = "TAS"
+
         [M_i, CAS_i, TAS_i] = atm.convertSpeed(
             v=v, speedType=speedType, theta=theta, delta=delta, sigma=sigma
         )
@@ -4178,6 +4254,7 @@ def constantSpeedSlope(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -4237,7 +4314,7 @@ def constantSpeedSlope_time(
         - config: Default aerodynamic configuration {TO, IC, CR, AP, LD}. If not provided, configuration is calculated automatically.
         - speedBrakes: Dictionary specifying if speed brakes are deployed and additional drag coefficient {deployed: False, value: 0.03}.
         - ROCD_min: Minimum Rate of Climb/Descent to determine service ceiling [ft/min]. Defaults depend on aircraft type and engine.
-        - mass_const: Boolean indicating whether mass remains constant during the flight. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for mass integration. Default is 5.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -4321,7 +4398,12 @@ def constantSpeedSlope_time(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -4473,6 +4555,25 @@ def constantSpeedSlope_time(
             )
 
             # aircraft speed
+            if calculationType == "POINT" and AC.BADAFamily.BADAH:
+                [
+                    Pav_POINT,
+                    Peng_POINT,
+                    Preq_POINT,
+                    tas_POINT,
+                    ROCD_POINT,
+                    ESF_POINT,
+                    limitation_POINT,
+                ] = AC.ARPM.ARPMProcedure(
+                    phase=phase,
+                    h=H_m,
+                    DeltaTemp=DeltaTemp,
+                    mass=mass[-1],
+                    rating="ARPM",
+                )
+                v = conv.ms2kt(tas_POINT)
+                speedType = "TAS"
+
             [M_i, CAS_i, TAS_i] = atm.convertSpeed(
                 v=v, speedType=speedType, theta=theta, delta=delta, sigma=sigma
             )
@@ -5175,6 +5276,7 @@ def constantSpeedSlope_time(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -5237,7 +5339,7 @@ def constantSpeedRating(
         - speedBrakes: A dictionary specifying whether speed brakes are deployed and the additional drag coefficient {deployed: False, value: 0.03}.
         - ROCD_min: Minimum rate of climb/descent used to determine service ceiling [ft/min]. Default varies based on aircraft type.
         - config: Default aerodynamic configuration (TO, IC, CR, AP, LD). Default is None.
-        - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for the mass integration loop. Default is 5.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -5321,7 +5423,12 @@ def constantSpeedRating(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -5504,6 +5611,25 @@ def constantSpeedRating(
         )
 
         # aircraft speed
+        if calculationType == "POINT" and AC.BADAFamily.BADAH:
+            [
+                Pav_POINT,
+                Peng_POINT,
+                Preq_POINT,
+                tas_POINT,
+                ROCD_POINT,
+                ESF_POINT,
+                limitation_POINT,
+            ] = AC.ARPM.ARPMProcedure(
+                phase=phase,
+                h=H_m,
+                DeltaTemp=DeltaTemp,
+                mass=mass[-1],
+                rating=rating,
+            )
+            v = conv.ms2kt(tas_POINT)
+            speedType = "TAS"
+
         [M_i, CAS_i, TAS_i] = atm.convertSpeed(
             v=v, speedType=speedType, theta=theta, delta=delta, sigma=sigma
         )
@@ -5580,9 +5706,12 @@ def constantSpeedRating(
                 M=M_i,
                 DeltaTemp=DeltaTemp,
             )  # [N]
-            CT = AC.CT(Thrust=THR_i, delta=delta)
             FUEL_i = AC.ff(
-                CT=CT, delta=delta, theta=theta, M=M_i, DeltaTemp=DeltaTemp
+                rating=rating,
+                delta=delta,
+                theta=theta,
+                M=M_i,
+                DeltaTemp=DeltaTemp,
             )
 
         # BADA3
@@ -5616,12 +5745,7 @@ def constantSpeedRating(
                 DeltaTemp=DeltaTemp,
             )
             FUEL_i = AC.ff(
-                flightPhase=phase,
-                v=TAS_i,
-                h=H_m,
-                T=THR_i,
-                config=config_i,
-                adapted=True,
+                flightPhase=phase, v=TAS_i, h=H_m, T=THR_i, config=config_i
             )
 
         if Hp_i != Hp_init:  # exclude first point: initial m already known
@@ -6095,6 +6219,7 @@ def constantSpeedRating(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -6160,7 +6285,7 @@ def constantSpeedRating_time(
         - speedBrakes: A dictionary specifying whether speed brakes are deployed and the additional drag coefficient {deployed: False, value: 0.03}.
         - ROCD_min: Minimum rate of climb/descent to determine service ceiling [ft/min]. Default varies by aircraft type.
         - config: Default aerodynamic configuration (TO, IC, CR, AP, LD). Default is None.
-        - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for the mass integration loop. Default is 5.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -6244,7 +6369,12 @@ def constantSpeedRating_time(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -6430,6 +6560,25 @@ def constantSpeedRating_time(
             )
 
             # aircraft speed
+            if calculationType == "POINT" and AC.BADAFamily.BADAH:
+                [
+                    Pav_POINT,
+                    Peng_POINT,
+                    Preq_POINT,
+                    tas_POINT,
+                    ROCD_POINT,
+                    ESF_POINT,
+                    limitation_POINT,
+                ] = AC.ARPM.ARPMProcedure(
+                    phase=phase,
+                    h=H_m,
+                    DeltaTemp=DeltaTemp,
+                    mass=mass[-1],
+                    rating=rating,
+                )
+                v = conv.ms2kt(tas_POINT)
+                speedType = "TAS"
+
             [M_i, CAS_i, TAS_i] = atm.convertSpeed(
                 v=v, speedType=speedType, theta=theta, delta=delta, sigma=sigma
             )
@@ -6508,9 +6657,12 @@ def constantSpeedRating_time(
                     M=M_i,
                     DeltaTemp=DeltaTemp,
                 )  # [N]
-                CT = AC.CT(Thrust=THR_i, delta=delta)
                 FUEL_i = AC.ff(
-                    CT=CT, delta=delta, theta=theta, M=M_i, DeltaTemp=DeltaTemp
+                    rating=rating,
+                    delta=delta,
+                    theta=theta,
+                    M=M_i,
+                    DeltaTemp=DeltaTemp,
                 )
 
             # BADA3
@@ -6544,12 +6696,7 @@ def constantSpeedRating_time(
                     DeltaTemp=DeltaTemp,
                 )
                 FUEL_i = AC.ff(
-                    flightPhase=phase,
-                    v=TAS_i,
-                    h=H_m,
-                    T=THR_i,
-                    config=config_i,
-                    adapted=False,
+                    flightPhase=phase, v=TAS_i, h=H_m, T=THR_i, config=config_i
                 )  # MCMB(climb) or IDLE(descent)
 
             # BADAH or BADAE
@@ -7008,6 +7155,7 @@ def constantSpeedRating_time(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -7082,7 +7230,7 @@ def accDec(
         - speed_step: Speed step size for the iterative calculation [-] for M, [kt] for TAS/CAS. Default is 0.01 Mach, 5 kt for TAS/CAS.
         - SOC_init: Initial battery state of charge for electric aircraft (BADAE) [%]. Default is 100.
         - config: Default aerodynamic configuration (TO, IC, CR, AP, LD). Default is None.
-        - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for the mass integration loop. Default is 10 for BADA3/4/H, 5 for BADAE.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -7166,7 +7314,12 @@ def accDec(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -8283,6 +8436,7 @@ def accDec(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory
 
 
@@ -8359,7 +8513,7 @@ def accDec_time(
         - step_length: Length of each time step in the calculation [s]. Default is 1 second.
         - SOC_init: Initial battery state of charge for electric aircraft (BADAE) [%]. Default is 100.
         - config: Default aerodynamic configuration (TO, IC, CR, AP, LD). Default is None.
-        - mass_const: Boolean indicating whether mass remains constant during the flight segment. Default is False.
+        - calculationType: String indicating whether calculation is performed as INTEGRATED or POINT. Default is INTEGRATED.
         - m_iter: Number of iterations for the mass integration loop. Default is 10 for BADA3/4/H, 5 for BADAE.
 
     :returns: A pandas DataFrame containing the flight trajectory with columns such as:
@@ -8443,7 +8597,12 @@ def accDec_time(
             raise Exception("Undefined Heading value combination")
 
     # calculation with constant mass (True) or integrated (False)
-    mass_const = kwargs.get("mass_const", False)
+    calculationType = kwargs.get("calculationType", "INTEGRATED")
+
+    if calculationType == "INTEGRATED":
+        mass_const = False
+    if calculationType == "POINT":
+        mass_const = True
 
     # optional parameter to define initial Baterry State of Charge (SOC)
     if AC.BADAFamily.BADAE:
@@ -9554,4 +9713,5 @@ def accDec_time(
     }
 
     flightTrajectory = FT.createFlightTrajectoryDataframe(flightData)
+
     return flightTrajectory

pyBADA/aircraft.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Generic airplane/helicopter performance module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 import abc

pyBADA/atmosphere.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Atmosphere module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 from math import sqrt, pow, exp, log

pyBADA/bada3.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Generic BADA3 aircraft performance module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 from math import sqrt, isnan, asin, atan
@@ -2270,7 +2267,7 @@ class FlightEnvelope(BADA3):
                     buffetLimit = self.lowSpeedBuffetLimit(
                         h=h, mass=mass, DeltaTemp=DeltaTemp, nz=nz
                     )
-                    if buffetLimit == float("Nan"):
+                    if isnan(buffetLimit):
                         Vmin = VminStall
                     else:
                         Vmin = max(

pyBADA/bada4.py

@@ -2116,6 +2116,9 @@ class FlightEnvelope(BADA4):
             theta=theta, delta=delta, mass=mass, HLid=HLid, LG=LG, nz=1.0
         )
 
+        if VminCertified is None or VmaxCertified is None:
+            return None
+
         maxCASList = []
         for CAS in np.linspace(
             VminCertified, VmaxCertified, num=200, endpoint=True

pyBADA/badaH.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Generic BADAH aircraft performance module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 import xml.etree.ElementTree as ET
@@ -4136,7 +4133,9 @@ class BadaHAircraft(BADAH):
 
                 else:
                     # AC name cannot be found
-                    raise ValueError(acName + " Cannot be found")
+                    raise ValueError(
+                        acName + " Cannot be found at: " + self.filePath
+                    )
 
     def __str__(self):
         return f"(BADAH, AC_name: {self.acName}, searched_AC_name: {self.SearchedACName}, model_ICAO: {self.ICAO}, ID: {id(self.AC)})"

pyBADA/configuration.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Common configuration module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 import os

pyBADA/constants.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Common constants module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 # Gravitational acceleration

pyBADA/conversions.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-pyBADA
 Common unit conversions module
-Developped @EUROCONTROL (EIH)
-2024
 """
 
 from math import pi