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

pyBADA/TCL.py

@@ -1,16 +1,12 @@
-# -*- coding: utf-8 -*-
-"""
-Trajectory Computation Light (TCL) for BADAH/BADAE/BADA3/BADA4 aircraft performance module
-"""
+"""Trajectory Computation Light (TCL) for BADAH/BADAE/BADA3/BADA4 aircraft
+performance module."""
 
-import os
 import numpy as np
 from pyBADA.geodesic import Vincenty as vincenty
 from pyBADA.geodesic import RhumbLine as rhumb
 from pyBADA.geodesic import Turn as turn
 
 from dataclasses import dataclass
-import importlib.util
 import itertools
 import warnings
 
@@ -57,10 +53,9 @@ def constantSpeedLevel(
     magneticDeclinationGrid=None,
     **kwargs,
 ):
-    """
-    Calculates the time, fuel consumption, and other parameters for a level flight
-    segment at a constant speed for a given aircraft in the BADA model. It supports step-climb,
-    constant heading (true or magnetic), and turns.
+    """Calculates the time, fuel consumption, and other parameters for a level
+    flight segment at a constant speed for a given aircraft in the BADA model.
+    It supports step-climb, constant heading (true or magnetic), and turns.
 
     The function handles different BADA families (BADA3, BADA4, BADAH, BADAE), and computes various
     parameters such as altitude, speed, fuel consumption, power, heading, and mass based on aircraft
@@ -176,7 +171,7 @@ def constantSpeedLevel(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -536,7 +531,6 @@ def constantSpeedLevel(
                     and Lon_i is not None
                     and (HDGMagnetic_i is not None or HDGTrue is not None)
                 ):
-
                     if headingToFly == "TRUE":
                         if not turnFlight:
                             if not constantHeading:
@@ -1190,9 +1184,10 @@ def constantSpeedROCD(
     magneticDeclinationGrid=None,
     **kwargs,
 ):
-    """
-    Computes the time, fuel consumption, and other parameters required for an aircraft to climb or descend
-    from a given initial altitude (Hp_init) to a final altitude (Hp_final) at a constant speed and rate of climb/descent (ROCD).
+    """Computes the time, fuel consumption, and other parameters required for
+    an aircraft to climb or descend from a given initial altitude (Hp_init) to
+    a final altitude (Hp_final) at a constant speed and rate of climb/descent
+    (ROCD).
 
     The function handles multiple BADA families (BADA3, BADA4, BADAH, BADAE), computing various parameters
     such as altitude, speed, fuel consumption, power, heading, and mass based on the aircraft's performance
@@ -1309,7 +1304,7 @@ def constantSpeedROCD(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -2229,10 +2224,10 @@ def constantSpeedROCD_time(
     magneticDeclinationGrid=None,
     **kwargs,
 ):
-    """
-    Computes the time, fuel consumption, and performance parameters required for an aircraft to
-    perform a climb or descent based on a set amount of time, while maintaining a constant speed and constant
-    rate of climb/descent (ROCD).
+    """Computes the time, fuel consumption, and performance parameters
+    required for an aircraft to perform a climb or descent based on a set
+    amount of time, while maintaining a constant speed and constant rate of
+    climb/descent (ROCD).
 
     The function supports various BADA families (BADA3, BADA4, BADAH, BADAE), with different handling for mass changes,
     aerodynamic configurations, and energy consumption. It calculates parameters such as fuel consumption, power
@@ -2343,7 +2338,7 @@ def constantSpeedROCD_time(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -3246,9 +3241,10 @@ def constantSpeedSlope(
     magneticDeclinationGrid=None,
     **kwargs,
 ):
-    """
-    Calculates time, fuel consumption, and other parameters required for an aircraft to perform a climb or descent
-    from an initial altitude (Hp_init) to a final altitude (Hp_final) while maintaining a constant speed and a constant slope.
+    """Calculates time, fuel consumption, and other parameters required for an
+    aircraft to perform a climb or descent from an initial altitude (Hp_init)
+    to a final altitude (Hp_final) while maintaining a constant speed and a
+    constant slope.
 
     It uses different models for BADA (Base of Aircraft Data) families (BADA3, BADA4, BADAH, BADAE) to compute key flight parameters
     such as energy consumption, rate of climb/descent (ROCD), fuel burn, mass changes, and power requirements. The function also supports
@@ -3359,7 +3355,7 @@ def constantSpeedSlope(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -4277,8 +4273,9 @@ def constantSpeedSlope_time(
     magneticDeclinationGrid=None,
     **kwargs,
 ):
-    """
-    Computes the time, fuel, and trajectory parameters required by an aircraft to climb or descend at constant speed and slope over a given duration.
+    """Computes the time, fuel, and trajectory parameters required by an
+    aircraft to climb or descend at constant speed and slope over a given
+    duration.
 
     This function models a trajectory with constant speed (either CAS, TAS, or Mach) and a specified slope (degrees). The aircraft's dynamics are modeled based on BADA family data (BADA3, BADA4, BADAH, BADAE), supporting various aircraft types including electric models. It also accounts for turns, heading changes, and wind effects.
 
@@ -4388,7 +4385,7 @@ def constantSpeedSlope_time(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -5300,9 +5297,10 @@ def constantSpeedRating(
     initRating=None,
     **kwargs,
 ):
-    """
-    Calculates time, fuel consumption, and other parameters required for an aircraft to perform a climb or descent
-    from an initial altitude (Hp_init) to a final altitude (Hp_final) while maintaining a constant speed and engine rating.
+    """Calculates time, fuel consumption, and other parameters required for an
+    aircraft to perform a climb or descent from an initial altitude (Hp_init)
+    to a final altitude (Hp_final) while maintaining a constant speed and
+    engine rating.
 
     It uses different models for BADA (Base of Aircraft Data) families (BADA3, BADA4, BADAH, BADAE) to compute key flight parameters
     such as fuel burn, rate of climb/descent (ROCD), thrust, drag, and energy requirements. The function also supports
@@ -5413,7 +5411,7 @@ def constantSpeedRating(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -5813,7 +5811,12 @@ def constantSpeedRating(
                 CL = AC.CL(M=M_i, delta=delta, mass=mass_i, nz=nz)
                 # compute drag coefficient
                 CD = AC.CD(
-                    M=M_i, CL=CL, HLid=HLid_i, LG=LG_i, speedBrakes=speedBrakes
+                    M=M_i,
+                    CL=CL,
+                    HLid=HLid_i,
+                    LG=LG_i,
+                    speedBrakes=speedBrakes,
+                    expedite=expedite,
                 )
                 # compute drag force
                 Drag = AC.D(M=M_i, delta=delta, CD=CD)
@@ -6244,9 +6247,9 @@ def constantSpeedRating_time(
     initRating=None,
     **kwargs,
 ):
-    """
-    Calculates the time, fuel consumption, and other flight parameters required for an aircraft to perform
-    a climb or descent at constant speed and engine rating for a specified duration.
+    """Calculates the time, fuel consumption, and other flight parameters
+    required for an aircraft to perform a climb or descent at constant speed
+    and engine rating for a specified duration.
 
     It uses different models for BADA (Base of Aircraft Data) families (BADA3, BADA4, BADAH, BADAE) to compute key parameters
     such as rate of climb/descent (ROCD), thrust, drag, fuel burn, and power requirements. The function also supports complex
@@ -6359,7 +6362,7 @@ def constantSpeedRating_time(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -6750,7 +6753,12 @@ def constantSpeedRating_time(
                 CL = AC.CL(M=M_i, delta=delta, mass=mass_i, nz=nz)
                 # compute drag coefficient
                 CD = AC.CD(
-                    M=M_i, CL=CL, HLid=HLid_i, LG=LG_i, speedBrakes=speedBrakes
+                    M=M_i,
+                    CL=CL,
+                    HLid=HLid_i,
+                    LG=LG_i,
+                    speedBrakes=speedBrakes,
+                    expedite=expedite,
                 )
                 # compute drag force
                 Drag = AC.D(M=M_i, delta=delta, CD=CD)
@@ -7178,10 +7186,10 @@ def accDec(
     magneticDeclinationGrid=None,
     **kwargs,
 ):
-    """
-    Calculates the time, fuel consumption, and other key flight parameters required for an aircraft
-    to perform an acceleration or deceleration from an initial speed (v_init) to a final speed (v_final)
-    during the climb, cruise, or descent phases of flight.
+    """Calculates the time, fuel consumption, and other key flight parameters
+    required for an aircraft to perform an acceleration or deceleration from
+    an initial speed (v_init) to a final speed (v_final) during the climb,
+    cruise, or descent phases of flight.
 
     The flight parameters are calculated using different models for the BADA (Base of Aircraft Data) families (BADA3, BADA4, BADAH, BADAE).
     The function can also accommodate different control laws, vertical evolution phases, wind conditions, and complex flight dynamics like turns.
@@ -7304,7 +7312,7 @@ def accDec(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -8460,10 +8468,10 @@ def accDec_time(
     magneticDeclinationGrid=None,
     **kwargs,
 ):
-    """
-    Calculates the time, fuel consumption, and other key flight parameters required for an aircraft
-    to perform an acceleration or deceleration from an initial speed (v_init) over a set period of time
-    during the climb, cruise, or descent phases of flight.
+    """Calculates the time, fuel consumption, and other key flight parameters
+    required for an aircraft to perform an acceleration or deceleration from
+    an initial speed (v_init) over a set period of time during the climb,
+    cruise, or descent phases of flight.
 
     The flight parameters are calculated using different models for the BADA (Base of Aircraft Data) families (BADA3, BADA4, BADAH, BADAE).
     The function can also accommodate different control laws, vertical evolution phases, wind conditions, and complex flight dynamics like turns.
@@ -8587,7 +8595,7 @@ def accDec_time(
             magneticHeading = trueHeading - magneticDeclination
         elif magneticHeading is not None and trueHeading is None:
             # fly MAGNETIC Heading
-            if constantHeading == True:
+            if constantHeading is True:
                 headingToFly = "MAGNETIC"
                 trueHeading = magneticHeading + magneticDeclination
             else:
@@ -8978,7 +8986,6 @@ def accDec_time(
                     if P_i < Pmin:
                         P_i = Pmin
                         if ESFc is not None:
-
                             ROCD_i = (
                                 conv.m2ft(
                                     AC.ROCD(

pyBADA/aircraft.py

@@ -1,9 +1,5 @@
-# -*- coding: utf-8 -*-
-"""
-Generic airplane/helicopter performance module
-"""
+"""Generic airplane/helicopter performance module."""
 
-import abc
 from math import sqrt, pow, cos, radians, atan, tan, degrees
 
 from pyBADA import constants as const
@@ -18,26 +14,31 @@ def checkArgument(argument, **kwargs):
         raise TypeError("Missing " + argument + " argument")
 
 
-class Bada(object):
-    """This class implements the mechanisms applicable across all BADA families."""
+class Bada:
+    """This class implements the mechanisms applicable across all BADA
+    families."""
 
     def __init__(self):
         pass
 
     @staticmethod
     def getBADAParameters(df, acName, parameters):
-        """
-        Retrieves specified parameters for a given aircraft name from a DataFrame.
+        """Retrieves specified parameters for a given aircraft name from a
+        DataFrame.
 
         :param df: DataFrame containing BADA aircraft data.
-        :param acName: Name of the aircraft or list of aircraft names to search for.
-        :param parameters: List of column names (or a single column name) to retrieve.
+        :param acName: Name of the aircraft or list of aircraft names to
+            search for.
+        :param parameters: List of column names (or a single column name) to
+            retrieve.
         :type df: pd.DataFrame
         :type acName: list or str
         :type parameters: list or str
-        :returns: A DataFrame containing the specified parameters for the given aircraft.
+        :returns: A DataFrame containing the specified parameters for the
+            given aircraft.
         :rtype: pd.DataFrame
-        :raises ValueError: If any of the specified columns or aircraft names are not found.
+        :raises ValueError: If any of the specified columns or aircraft names
+            are not found.
         """
 
         # Ensure parameters is a list
@@ -70,8 +71,7 @@ class Bada(object):
 
     @staticmethod
     def loadFactor(fi):
-        """
-        Computes the load factor from a given bank angle.
+        """Computes the load factor from a given bank angle.
 
         The load factor is calculated based on the cosine of the bank angle,
         which is expressed in degrees. A small rounding operation is applied
@@ -87,8 +87,8 @@ class Bada(object):
 
     @staticmethod
     def bankAngle(rateOfTurn, v):
-        """
-        Computes the bank angle based on true airspeed (TAS) and rate of turn.
+        """Computes the bank angle based on true airspeed (TAS) and rate of
+        turn.
 
         :param v: True airspeed (TAS) in meters per second (m/s).
         :param rateOfTurn: Rate of turn in degrees per second (deg/s).
@@ -105,8 +105,8 @@ class Bada(object):
 
     @staticmethod
     def rateOfTurn(v, nz=1.0):
-        """
-        Computes the rate of turn based on true airspeed (TAS) and load factor.
+        """Computes the rate of turn based on true airspeed (TAS) and load
+        factor.
 
         :param v: True airspeed (TAS) in meters per second (m/s).
         :param nz: Load factor (default is 1.0), dimensionless.
@@ -120,8 +120,8 @@ class Bada(object):
 
     @staticmethod
     def rateOfTurn_bankAngle(TAS, bankAngle):
-        """
-        Computes the rate of turn based on true airspeed (TAS) and bank angle.
+        """Computes the rate of turn based on true airspeed (TAS) and bank
+        angle.
 
         :param TAS: True airspeed (TAS) in meters per second (m/s).
         :param bankAngle: Bank angle in degrees.
@@ -137,8 +137,8 @@ class Bada(object):
 
     @staticmethod
     def turnRadius(v, nz=1.0):
-        """
-        Computes the turn radius based on true airspeed (TAS) and load factor.
+        """Computes the turn radius based on true airspeed (TAS) and load
+        factor.
 
         :param v: True airspeed (TAS) in meters per second (m/s).
         :param nz: Load factor (default is 1.0), dimensionless.
@@ -152,8 +152,8 @@ class Bada(object):
 
     @staticmethod
     def turnRadius_bankAngle(v, ba):
-        """
-        Computes the turn radius based on true airspeed (TAS) and bank angle.
+        """Computes the turn radius based on true airspeed (TAS) and bank
+        angle.
 
         :param v: True airspeed (TAS) in meters per second (m/s).
         :param ba: Bank angle in degrees.
@@ -167,8 +167,8 @@ class Bada(object):
 
     @staticmethod
     def GS(tas, gamma, Ws):
-        """
-        Computes the ground speed based on true airspeed (TAS), flight path angle, and wind speed.
+        """Computes the ground speed based on true airspeed (TAS), flight path
+        angle, and wind speed.
 
         :param tas: True airspeed (TAS) in meters per second (m/s).
         :param gamma: Flight path angle in degrees.
@@ -183,7 +183,7 @@ class Bada(object):
         return tas * cos(radians(gamma)) + Ws
 
 
-class BadaFamily(object):
+class BadaFamily:
     """This class sets the token for the respected BADA Family."""
 
     def __init__(self, BADA3=False, BADA4=False, BADAH=False, BADAE=False):
@@ -193,14 +193,14 @@ class BadaFamily(object):
         self.BADAE = BADAE
 
 
-class Airplane(object):
-    """This is a generic airplane class based on a three-degrees-of-freedom point mass model (where all the forces
-    are applied at the center of gravity).
+class Airplane:
+    """This is a generic airplane class based on a three-degrees-of-freedom
+    point mass model (where all the forces are applied at the center of
+    gravity).
 
     .. note::this generic class only implements basic aircraft dynamics
             calculations, aircraft performance and optimisation can be obtained
             from its inherited classes
-
     """
 
     def __init__(self):
@@ -208,12 +208,12 @@ class Airplane(object):
 
     @staticmethod
     def esf(**kwargs):
-        """
-        Computes the energy share factor based on flight conditions.
+        """Computes the energy share factor based on flight conditions.
 
         :param h: Altitude in meters.
         :param DeltaTemp: Temperature deviation with respect to ISA in Kelvin.
-        :param flightEvolution: Type of flight evolution [constM/constCAS/acc/dec].
+        :param flightEvolution: Type of flight evolution
+            [constM/constCAS/acc/dec].
         :param phase: Phase of flight [cl/des].
         :param v: Constant speed (Mach number).
         :type h: float
@@ -315,13 +315,12 @@ class Airplane(object):
         return ESF
 
 
-class Helicopter(object):
+class Helicopter:
     """This is a generic helicopter class based on a Total-Energy Model (TEM)
 
     .. note::this generic class only implements basic aircraft dynamics
             calculations, aircraft performance and optimisation can be obtained
             from its inherited classes
-
     """
 
     def __init__(self):
@@ -329,12 +328,12 @@ class Helicopter(object):
 
     @staticmethod
     def esf(**kwargs):
-        """
-        Computes the energy share factor based on flight conditions.
+        """Computes the energy share factor based on flight conditions.
 
         :param h: Altitude in meters.
         :param DeltaTemp: Temperature deviation with respect to ISA in Kelvin.
-        :param flightEvolution: Type of flight evolution [constTAS/constCAS/acc/dec].
+        :param flightEvolution: Type of flight evolution
+            [constTAS/constCAS/acc/dec].
         :param phase: Phase of flight [Climb/Descent].
         :param v: Constant speed (Mach number).
         :type h: float