pyBADA 0.1.7__py3-none-any.whl → 0.1.8__py3-none-any.whl

pyBADA/bada4.py

@@ -2489,7 +2489,7 @@ class FlightEnvelope(BADA4):
                     x1=np.array([0]),
                     x2=np.array([conv.ft2m(hMax)]),
                     disp=False,
-                )
+                ).item()
             )
 
         return hMax

pyBADA/badaAircraft.py

@@ -0,0 +1,35 @@
+"""Generic BADA Family Wrapper."""
+
+from typing import Union
+
+from pyBADA.bada3 import Bada3Aircraft
+from pyBADA.bada4 import Bada4Aircraft
+from pyBADA.badaH import BadaHAircraft
+
+
+class BadaAircraft:
+    """
+    A wrapper to handle the instantiation of different BADA family models.
+    """
+
+    _FAMILY_MAP = {
+        "BADA3": Bada3Aircraft,
+        "BADA4": Bada4Aircraft,
+        "BADAH": BadaHAircraft,
+    }
+
+    def __new__(
+        cls, badaFamily, badaVersion, acName, **kwargs
+    ) -> Union[Bada3Aircraft, Bada4Aircraft, BadaHAircraft]:
+        target_class = cls._FAMILY_MAP.get(badaFamily)
+
+        if not target_class:
+            valid_keys = list(cls._FAMILY_MAP.keys())
+            raise ValueError(
+                f"Unknown BADA family: '{badaFamily}'. Valid options: {valid_keys}"
+            )
+
+        return target_class(badaVersion=badaVersion, acName=acName, **kwargs)
+
+    def __init__(self, *args, **kwargs):
+        pass

pyBADA/configuration.py

@@ -154,6 +154,56 @@ def getAircraftList(badaFamily, badaVersion):
     return aircraftList
 
 
+def getAircraftListAndCategory(badaFamily, badaVersion):
+    """Retrieve a list of available aircraft for a given BADA family and
+    version with matching category from release file.
+
+    :param badaFamily: The BADA family (e.g., BADA3, BADA4) for which
+        aircraft are being retrieved.
+    :param badaVersion: The specific version of the BADA family (e.g.,
+        3.10, 4.2).
+    :type badaFamily: str.
+    :type badaVersion: str.
+    :returns: List of available aircraft names and categories.
+    :rtype: pandas dataframe.
+    """
+
+    aircraft_names = getAircraftList(badaFamily, badaVersion)
+
+    if badaFamily == "BADA4":
+        path = getBadaVersionPath(badaFamily, badaVersion)
+        csv_path = os.path.join(path, "release.csv")
+
+        df_files = pd.DataFrame(aircraft_names, columns=["AIRCRAFT"])
+
+        if os.path.exists(csv_path):
+            df_csv = pd.read_csv(csv_path, sep=";")
+            df_csv = df_csv.rename(
+                columns={"filename": "AIRCRAFT", "category": "CATEGORY"}
+            )
+            df_result = pd.merge(
+                df_files,
+                df_csv[["AIRCRAFT", "CATEGORY"]],
+                on="AIRCRAFT",
+                how="left",
+            )
+
+            return df_result
+
+        else:
+            # Fallback: If CSV is missing, return list with None categories
+            df_files["CATEGORY"] = None
+            return df_files
+
+    elif badaFamily in ["BADA3", "BADAH", "BADAE"]:
+        data = []
+        for item in aircraft_names:
+            data.append({"AIRCRAFT": item, "CATEGORY": None})
+        return pd.DataFrame(data, columns=["AIRCRAFT", "CATEGORY"])
+
+    return pd.DataFrame(columns=["AIRCRAFT", "CATEGORY"])
+
+
 def getBadaFamilyPath(badaFamily):
     """Get the full path to the specified BADA family directory.
 

pyBADA/myTypes.py

@@ -0,0 +1,204 @@
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Literal
+
+
+class CalculationType(StrEnum):
+    POINT = "POINT"
+    INTEGRATED = "INTEGRATED"
+
+
+class FlightPhase(StrEnum):
+    CLIMB = "CLIMB"
+    DESCENT = "DESCENT"
+    CRUISE = "CRUISE"
+
+
+class AccelerationOption(StrEnum):
+    ROCD_ESF = "ROCD_ESF"
+    ROCD_ACC = "ROCD_ACC"
+    SLOPE_ACC = "SLOPE_ACC"
+    SLOPE_ESF = "SLOPE_ESF"
+    ROCD_RATING = "ROCD_RATING"
+    SLOPE_RATING = "SLOPE_RATING"
+    ESF_RATING = "ESF_RATING"
+    ACC_RATING = "ACC_RATING"
+
+
+class SpeedType(StrEnum):
+    TAS = "TAS"
+    CAS = "CAS"
+    M = "M"
+
+
+class AccelerationLevelKind(StrEnum):
+    AT = "AT"
+    BEFORE = "BEFORE"
+    AFTER = "AFTER"
+
+
+@dataclass
+class Speed:
+    speedType: SpeedType | None = None
+    accelerationLevelKind: AccelerationLevelKind | None = None
+    initSpeed: float | None = None
+    finalSpeed: float | None = None
+    stepSpeed: float | None = None
+
+
+@dataclass
+class SpeedBrakes:
+    deployed: float | None = None
+    value: float | None = None
+
+
+@dataclass
+class CASMACHSpeedSchedule:
+    CASbelowFL100: float | None = None
+    CASaboveFL100: float | None = None
+    Mach: float | None = None
+
+
+@dataclass
+class Meteo:
+    wS: float = 0.0  # Wind speed [kt], default to 0
+    deltaTemp: float = 0.0  # Temperature deviation [K], default to 0
+
+
+@dataclass
+class PressureAltitude:
+    initPressureAltitude: float | None = None
+    finalPressureAltitude: float | None = None
+    stepPressureAltitude: float | None = None
+
+
+@dataclass
+class ControlTarget:
+    ROCDtarget: float | None = None
+    slopetarget: float | None = None
+    acctarget: float | None = None
+    ESFtarget: float | None = None
+
+
+class TakeOffProcedureType(StrEnum):
+    BADA = "BADA"
+    NADP1 = "NADP1"
+    NADP2 = "NADP2"
+
+
+@dataclass
+class TakeOffProcedureBADA:
+    type: Literal[TakeOffProcedureType.BADA] = TakeOffProcedureType.BADA
+
+
+@dataclass
+class TakeOffProcedureNADP1:
+    NADP1Threshold: float | None = None
+    type: Literal[TakeOffProcedureType.NADP1] = TakeOffProcedureType.NADP1
+
+
+@dataclass
+class TakeOffProcedureNADP2:
+    NADP2Threshold1: float | None = None
+    NADP2Threshold2: float | None = None
+    type: Literal[TakeOffProcedureType.NADP2] = TakeOffProcedureType.NADP2
+
+
+TakeOffProcedure = (
+    TakeOffProcedureBADA | TakeOffProcedureNADP1 | TakeOffProcedureNADP2
+)
+
+
+class DepartureProfileType(StrEnum):
+    constCASbelow100 = "constCASbelow100"
+    calculatedCAS = "calculatedCAS"
+
+
+@dataclass
+class DepartureProfile:
+    departureProfileType: DepartureProfileType | None = None
+
+
+class ArrivalProfileType(StrEnum):
+    constCASbelow100 = "constCASbelow100"
+    calculatedCAS = "calculatedCAS"
+    expedite = "expedite"
+
+
+@dataclass
+class ArrivalProfile:
+    arrivalProfileType: ArrivalProfileType | None = None
+
+
+class ClimbType(StrEnum):
+    CASMACH = "CASMACH"
+    RATE = "RATE"
+    ACCELERATION = "ACCELERATION"
+
+
+class DescentType(StrEnum):
+    CASMACH = "CASMACH"
+    RATE = "RATE"
+    SLOPE = "SLOPE"
+    ACCELERATION = "ACCELERATION"
+    EMERGENCY = "EMERGENCY"
+
+
+class CruiseType(StrEnum):
+    CONSTANTSPEED = "CONSTANTSPEED"
+    ACCELERATION = "ACCELERATION"
+
+
+class CruiseSpeedType(StrEnum):
+    TAS = "TAS"
+    CAS = "CAS"
+    M = "M"
+    MEC = "MEC"
+    LRC = "LRC"
+    MRC = "MRC"
+    ECON = "ECON"
+
+
+class HDescentType(StrEnum):
+    ARPM = "ARPM"
+    RATE = "RATE"
+    SLOPE = "SLOPE"
+    ACCELERATION = "ACCELERATION"
+    EMERGENCY = "EMERGENCY"
+
+
+class HClimbType(StrEnum):
+    RATE = "RATE"
+    ARPM = "ARPM"
+    ACCELERATION = "ACCELERATION"
+
+
+class HRating(StrEnum):
+    MTKF = "MTKF"
+    MCNT = "MCNT"
+    ARPM = "ARPM"
+
+
+class IntegrationType(StrEnum):
+    ALTITUDE = "ALTITUDE"
+    DISTANCE = "DISTANCE"
+    TIME = "TIME"
+
+
+@dataclass
+class HClimbRatingConfiguration:
+    rating: HRating | None = None
+
+
+@dataclass
+class ClimbCASMACHProfileConfiguration:
+    casMachSpeedSchedule: CASMACHSpeedSchedule | None = None
+    takeOffProcedure: TakeOffProcedure | None = None
+    departureProfile: DepartureProfile | None = None
+    reducedPower: bool = False
+
+
+@dataclass
+class DescentCASMACHProfileConfiguration:
+    casMachSpeedSchedule: CASMACHSpeedSchedule | None = None
+    arrivalProfile: ArrivalProfile | None = None