pyBADA 0.1.6__tar.gz → 0.1.7__tar.gz

{pybada-0.1.6 → pybada-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyBADA
-Version: 0.1.6
+Version: 0.1.7
 Summary: Aircraft performance modelling, trajectory prediction and optimisation, and visualisation with EUROCONTROL's BADA.
 Project-URL: Homepage, https://github.com/eurocontrol-bada/pybada
 Author-email: Henrich Glaser-Opitz <henrich.glaser-opitz@eurocontrol.int>, Antonio Vivace <antonio.vivace@eurocontrol.int>
@@ -11,19 +11,19 @@ Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Requires-Dist: numpy>=2.3.2
-Requires-Dist: pandas>=2.3.1
+Requires-Dist: pandas>=2.3.2
 Requires-Dist: scipy>=1.16.1
 Requires-Dist: simplekml>=1.3.6
-Requires-Dist: xarray>=2025.7.1
+Requires-Dist: xarray>=2025.9.0
 Requires-Dist: xlsxwriter>=3.2.5
 Provides-Extra: dev
 Requires-Dist: build; extra == 'dev'
 Requires-Dist: folium==0.20.0; extra == 'dev'
-Requires-Dist: matplotlib==3.10.5; extra == 'dev'
+Requires-Dist: matplotlib==3.10.6; extra == 'dev'
 Requires-Dist: pre-commit==4.2.0; extra == 'dev'
-Requires-Dist: pytest==8.4.1; extra == 'dev'
+Requires-Dist: pytest==8.4.2; extra == 'dev'
 Requires-Dist: readthedocs-sphinx-search>=0.3.2; extra == 'dev'
-Requires-Dist: ruff==0.11.5; extra == 'dev'
+Requires-Dist: ruff==0.12.12; extra == 'dev'
 Requires-Dist: sphinx-gallery==0.19.0; extra == 'dev'
 Requires-Dist: sphinx-rtd-theme==3.0.2; extra == 'dev'
 Requires-Dist: sphinx==8.2.3; extra == 'dev'
@@ -37,7 +37,7 @@ Description-Content-Type: text/markdown
 <a href="https://pypi.org/project/pyBADA"><img alt="Released on PyPi" src="https://img.shields.io/pypi/v/pyBADA.svg"></a> <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/pybada"> ![Python 3.12](https://img.shields.io/badge/Python-3.12-3776AB.svg?logo=python&logoColor=white)
 <a href="https://github.com/eurocontrol-bada/pybada"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 [![Run unit tests](https://github.com/eurocontrol-bada/pybada/actions/workflows/pytest.yml/badge.svg)](https://github.com/eurocontrol-bada/pybada/actions/workflows/pytest.yml)
-![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/pyBADA_dev?style=social&label=Follow%20%40pyBADA_dev)
+[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/pyBADA_dev?style=social&label=Follow%20%40pyBADA_dev)](https://x.com/intent/follow?screen_name=pyBADA_dev)
 
 This package provides aircraft performance modelling, trajectory prediction and optimisation, and visualisation with [BADA](https://www.eurocontrol.int/model/bada) in Python.
 

{pybada-0.1.6 → pybada-0.1.7}/README.md

@@ -5,7 +5,7 @@
 <a href="https://pypi.org/project/pyBADA"><img alt="Released on PyPi" src="https://img.shields.io/pypi/v/pyBADA.svg"></a> <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/pybada"> ![Python 3.12](https://img.shields.io/badge/Python-3.12-3776AB.svg?logo=python&logoColor=white)
 <a href="https://github.com/eurocontrol-bada/pybada"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 [![Run unit tests](https://github.com/eurocontrol-bada/pybada/actions/workflows/pytest.yml/badge.svg)](https://github.com/eurocontrol-bada/pybada/actions/workflows/pytest.yml)
-![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/pyBADA_dev?style=social&label=Follow%20%40pyBADA_dev)
+[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/pyBADA_dev?style=social&label=Follow%20%40pyBADA_dev)](https://x.com/intent/follow?screen_name=pyBADA_dev)
 
 This package provides aircraft performance modelling, trajectory prediction and optimisation, and visualisation with [BADA](https://www.eurocontrol.int/model/bada) in Python.
 

{pybada-0.1.6 → pybada-0.1.7}/examples/combinedSlopeAndDestination.py

@@ -12,25 +12,25 @@ from pyBADA import geodesic as geo
 
 # ——— Inputs for required–slope example ———
 waypoint1 = {
-    'latitude': 52.2367946579192,
-    'longitude': 20.7129809016565,
-    'altitude': 3500.0       # ft
+    "latitude": 52.2367946579192,
+    "longitude": 20.7129809016565,
+    "altitude": 3500.0,  # ft
 }
 waypoint2 = {
-    'latitude': 52.1697191213371,
-    'longitude': 20.9519554471793,
-    'altitude': 412.0        # ft
+    "latitude": 52.1697191213371,
+    "longitude": 20.9519554471793,
+    "altitude": 412.0,  # ft
 }
 
 # ——— Inputs for destination–point example ———
 initial_waypoint = waypoint1.copy()
-slope_deg       = 3.5        # degrees (positive = climb)
-distance_nm     = 12.0       # nautical miles
-bearing_deg     = 75.0       # degrees from true north
+slope_deg = 3.5  # degrees (positive = climb)
+distance_nm = 12.0  # nautical miles
+bearing_deg = 75.0  # degrees from true north
 
 # ——— Run both examples for each algorithm ———
 for algo_name, Algo in [
-    ("Vincenty",  geo.Vincenty),
+    ("Vincenty", geo.Vincenty),
     ("Haversine", geo.Haversine),
     ("RhumbLine", geo.RhumbLine),
 ]:
@@ -45,12 +45,9 @@ for algo_name, Algo in [
 
     # 2) Destination point given a slope, distance & bearing
     dest_wp = Algo.destinationPointApplyingSlopeForDistance(
-        initial_waypoint,
-        slope_deg,
-        distance_nm,
-        bearing_deg
+        initial_waypoint, slope_deg, distance_nm, bearing_deg
     )
     print("Destination waypoint applying slope & distance:")
     print(f"  Latitude  = {dest_wp['latitude']:.6f}°")
     print(f"  Longitude = {dest_wp['longitude']:.6f}°")
-    print(f"  Altitude  = {dest_wp['altitude']:.2f} ft")
+    print(f"  Altitude  = {dest_wp['altitude']:.2f} ft")

pybada-0.1.7/examples/fuelFlow.py

@@ -0,0 +1,215 @@
+"""
+Fuel Flow Calculation
+========================
+
+Example calculation of aircraft fuel flow in descent
+
+"""
+
+from math import sin
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+from pyBADA import atmosphere as atm
+from pyBADA import constants as const
+from pyBADA import conversions as conv
+from pyBADA import utils
+from pyBADA.bada3 import Bada3Aircraft
+from pyBADA.bada4 import Bada4Aircraft
+
+# create an aircraft
+ACList = [
+    Bada4Aircraft(badaVersion="DUMMY", acName="Dummy-TWIN"),
+    Bada3Aircraft(badaVersion="DUMMY", acName="J2M"),
+]
+
+# deviation from ISA temperature
+deltaTemp = 0
+
+# definition of altitude range
+fl_array = np.arange(0, 401, 10)
+altitude_array = conv.ft2m(fl_array * 100)
+
+# --- collect per-aircraft series here ---
+series = []  # list of dicts: {"label": str, "alt_ft": list[float], "ff": list[float]}
+
+for AC in ACList:
+    # define aircraft mass - here as reference mass
+    mass = AC.MREF
+
+    # get the original speed schedule for descent for this aircraft
+    [Vdes1, Vdes2, Mdes] = AC.flightEnvelope.getSpeedSchedule(phase="Descent")
+
+    # crossover altitude
+    crossAlt = atm.crossOver(cas=Vdes2, Mach=Mdes)
+
+    label = f"({AC.BADAFamilyName}) {AC.acName.strip('_')} (BADA {getattr(AC, 'BADAVersion')}) {mass} kg"
+
+    alt_ft_vals = []
+    ff_vals = []
+
+    print(
+        f"\n=== {AC.__class__.__name__}  |  BADA {AC.BADAVersion}  |  Mass: {mass:.0f} kg ==="
+    )
+    print(
+        f"{'FL':>4}  {'Alt(ft)':>8}  {'Cfg':>3}  {'M':>6}  {'FF (kg/s)':>10}"
+    )
+    print("-" * 39)
+
+    for alt in altitude_array:
+        # atmosphere properties
+        theta, delta, sigma = atm.atmosphereProperties(
+            h=alt, deltaTemp=deltaTemp
+        )
+
+        # determine the speed acording to BADA ARPM
+        [cas, speedUpdated] = AC.ARPM.descentSpeed(
+            h=alt, mass=mass, theta=theta, delta=delta, deltaTemp=deltaTemp
+        )
+        # general speed conversion
+        [M, CAS, TAS] = atm.convertSpeed(
+            v=conv.ms2kt(cas),
+            speedType="CAS",
+            theta=theta,
+            delta=delta,
+            sigma=sigma,
+        )
+
+        # determine the aerodynamic configuration if necesary
+        config = AC.flightEnvelope.getConfig(
+            h=alt, phase="Descent", v=CAS, mass=mass, deltaTemp=deltaTemp
+        )
+
+        # calculate Energy Share Factor depending if aircraft is flying constant M or CAS (based on crossover altitude)
+        if alt < crossAlt:
+            ESF = AC.esf(
+                h=alt, flightEvolution="constCAS", M=M, deltaTemp=deltaTemp
+            )
+        else:
+            ESF = AC.esf(
+                h=alt, flightEvolution="constM", M=M, deltaTemp=deltaTemp
+            )
+
+        # =====
+        # BADA4
+        # =====
+        if AC.BADAFamily.BADA4:
+            # =================================================================================
+            # for altitudes where aircraft descends on 3degree slope in AP and LD configuration
+            # =================================================================================
+            if config == "AP" or config == "LD":
+                gamma = -3.0
+                temp_const = (theta * const.temp_0) / (
+                    theta * const.temp_0 - deltaTemp
+                )
+                ROCD_gamma = sin(conv.deg2rad(gamma)) * TAS * (1 / temp_const)
+
+                n = 1.0
+                [HLid, LG] = AC.flightEnvelope.getAeroConfig(config=config)
+                CL = AC.CL(M=M, delta=delta, mass=mass, nz=n)
+                CD = AC.CD(M=M, CL=CL, HLid=HLid, LG=LG)
+                Drag = AC.D(M=M, delta=delta, CD=CD)
+                Thrust = (ROCD_gamma * mass * const.g) * temp_const / (
+                    ESF * TAS
+                ) + Drag
+                CT = AC.CT(Thrust=Thrust, delta=delta)
+                ff = AC.ff(
+                    CT=CT, delta=delta, theta=theta, M=M, deltaTemp=deltaTemp
+                )
+
+            # =============================================================
+            # for altitudes where aircraft descends in IDLE engine settings
+            # =============================================================
+            else:
+                ff = AC.ff(
+                    rating="LIDL",
+                    delta=delta,
+                    theta=theta,
+                    M=M,
+                    deltaTemp=deltaTemp,
+                )  # [kg/s]
+
+        # =====
+        # BADA3
+        # =====
+        elif AC.BADAFamily.BADA3:
+            adaptedThrust = False
+            if AC.engineType in ("PISTON", "ELECTRIC"):
+                # PISTON  and ELECTRIC uses LIDL throughout the whole descent phase
+                config = "CR"
+                adaptedThrust = True
+
+            # =================================================================================
+            # for altitudes where aircraft descends on 3degree slope in AP and LD configuration
+            # =================================================================================
+            if config in ("AP", "LD"):
+                gamma = -3.0
+                temp_const = (theta * const.temp_0) / (
+                    theta * const.temp_0 - deltaTemp
+                )
+                ROCD_gamma = sin(conv.deg2rad(gamma)) * TAS * (1 / temp_const)
+
+                n = 1.0
+                CL = AC.CL(sigma=sigma, mass=mass, tas=TAS, nz=n)
+                CD = AC.CD(CL=CL, config=config)
+                Drag = AC.D(sigma=sigma, tas=TAS, CD=CD)
+                Thrust = AC.Thrust(
+                    rating="ADAPTED",
+                    v=TAS,
+                    config=config,
+                    h=alt,
+                    ROCD=ROCD_gamma,
+                    mass=mass,
+                    acc=0,
+                    deltaTemp=deltaTemp,
+                    Drag=Drag,
+                )
+                ff = AC.ff(
+                    flightPhase="Descent",
+                    v=TAS,
+                    h=alt,
+                    T=Thrust,
+                    config=config,
+                    adapted=adaptedThrust,
+                )
+
+            # =============================================================
+            # for altitudes where aircraft descends in IDLE engine settings
+            # =============================================================
+            else:
+                ff = AC.ff(
+                    v=TAS,
+                    h=alt,
+                    T=Thrust,
+                    flightPhase="Descent",
+                    config=config,
+                )
+
+        fl = int(utils.proper_round(conv.m2ft(alt) / 100))
+        alt_ft = conv.m2ft(alt)
+        print(f"{fl:>4d}  {alt_ft:>8.0f}  {config:>3}  {M:>6.3f}  {ff:>10.6f}")
+
+        alt_ft_vals.append(alt_ft)
+        ff_vals.append(float(ff))
+
+    series.append(
+        {
+            "label": label,
+            "alt_ft": np.array(alt_ft_vals),
+            "ff": np.array(ff_vals),
+        }
+    )
+
+# --- PLOT: Fuel flow vs Altitude for all aircraft ---
+plt.figure(figsize=(8, 5))
+for s in series:
+    plt.plot(s["alt_ft"], s["ff"], label=s["label"])
+
+plt.xlabel("Altitude (ft)")
+plt.ylabel("Fuel Flow (kg/s)")
+plt.title("Descent Fuel Flow vs Altitude")
+plt.grid(True, which="both", linestyle="--", linewidth=0.5)
+plt.legend()
+plt.tight_layout()
+plt.show()

{pybada-0.1.6 → pybada-0.1.7}/examples/initialMass.py

@@ -17,22 +17,22 @@ from pyBADA.badaH import BadaHAircraft
 AC = Bada3Aircraft(badaVersion="DUMMY", acName="J2M")
 
 # Common inputs
-DeltaTemp           = 0                 # deviation from ISA temperature [K]
-M                   = 0.7               # Mach number [-]
-altitude            = conv.ft2m(30000)  # cruise altitude [m]
-distance            = conv.nm2m(100)    # flown distance [m]
-payload             = 80                # payload mass [% of max payload]
-fuelReserve         = 3600              # fuel reserve [s]
-flightPlanInitMass  = None              # planned takeoff mass [kg]
+deltaTemp = 0  # deviation from ISA temperature [K]
+M = 0.7  # Mach number [-]
+altitude = conv.ft2m(30000)  # cruise altitude [m]
+distance = conv.nm2m(100)  # flown distance [m]
+payload = 80  # payload mass [% of max payload]
+fuelReserve = 3600  # fuel reserve [s]
+flightPlanInitMass = None  # planned takeoff mass [kg]
 
 # Precompute atmosphere & speed inputs
-theta, delta, sigma = atm.atmosphereProperties(h=altitude, DeltaTemp=DeltaTemp)
-TAS                  = atm.mach2Tas(Mach=M, theta=theta)
-GS                   = TAS  # assume no wind
+theta, delta, sigma = atm.atmosphereProperties(h=altitude, deltaTemp=deltaTemp)
+TAS = atm.mach2Tas(Mach=M, theta=theta)
+GS = TAS  # assume no wind
 
 # Specify acName per model
 for model_name, ACClass, acName in [
-    ("BADA3", Bada3Aircraft,        "J2M"),
+    ("BADA3", Bada3Aircraft, "J2M"),
     ("BADA4", Bada4Aircraft, "Dummy-TWIN-plus"),
     ("BADAH", BadaHAircraft, "DUMH"),
 ]:
@@ -41,7 +41,7 @@ for model_name, ACClass, acName in [
 
     # 1) Cruise fuel flow [kg/s]
     cruiseFuelFlow = TP.cruiseFuelConsumption(
-        AC=AC, altitude=altitude, M=M, DeltaTemp=DeltaTemp
+        AC=AC, altitude=altitude, M=M, deltaTemp=deltaTemp
     )
     print(f"cruiseFuelFlow:          {cruiseFuelFlow:.6f} kg/s")
 
@@ -65,6 +65,6 @@ for model_name, ACClass, acName in [
         payload=payload,
         fuelReserve=fuelReserve,
         flightPlanInitialMass=flightPlanInitMass,
-        DeltaTemp=DeltaTemp,
+        deltaTemp=deltaTemp,
     )
-    print(f"initMass(limited):       {initMass:.2f} kg")
+    print(f"initMass(limited):       {initMass:.2f} kg")

{pybada-0.1.6 → pybada-0.1.7}/examples/optimumSpeedAndAltitude.py

@@ -20,17 +20,17 @@ print("BADA4 Optimum Speed and Altitude:")
 if AC.BADAFamily.BADA4:
     mass = AC.MTOW  # [kg] AC weight
     h = conv.ft2m(33000)  # [m] AC flight altitdue
-    DeltaTemp = 0  # [K] temperature deviation from ISA
+    deltaTemp = 0  # [K] temperature deviation from ISA
     cI = 50  # [kg min^-1] cost index
     wS = 0  # [m s^-1] longitudinal wind speed
 
     [theta, delta, sigma] = atm.atmosphereProperties(
-        h=h, DeltaTemp=DeltaTemp
+        h=h, deltaTemp=deltaTemp
     )  # atmosphere properties
 
     # Economic Mach Cruise Speed
     econMach = AC.OPT.econMach(
-        theta=theta, delta=delta, mass=mass, DeltaTemp=DeltaTemp, cI=cI, wS=wS
+        theta=theta, delta=delta, mass=mass, deltaTemp=deltaTemp, cI=cI, wS=wS
     )
     print("EconMach = ", econMach)
 
@@ -41,7 +41,7 @@ if AC.BADAFamily.BADA4:
 
     # Maximum Range Cruise (MRC) Mach speed
     MRC = AC.OPT.MRC(
-        theta=theta, delta=delta, mass=mass, DeltaTemp=DeltaTemp, wS=wS
+        theta=theta, delta=delta, mass=mass, deltaTemp=deltaTemp, wS=wS
     )
     print("MRC = ", MRC)
 
@@ -50,7 +50,7 @@ if AC.BADAFamily.BADA4:
 
     # Long Range Cruise (LRC) Mach speed
     LRC = AC.OPT.LRC(
-        theta=theta, delta=delta, mass=mass, DeltaTemp=DeltaTemp, wS=wS
+        theta=theta, delta=delta, mass=mass, deltaTemp=deltaTemp, wS=wS
     )
     print("LRC = ", LRC)
 
@@ -59,7 +59,7 @@ if AC.BADAFamily.BADA4:
 
     # Maximum Endurance Cruise (MEC) Mach speed
     MEC = AC.OPT.MEC(
-        theta=theta, delta=delta, mass=mass, DeltaTemp=DeltaTemp, wS=wS
+        theta=theta, delta=delta, mass=mass, deltaTemp=deltaTemp, wS=wS
     )
     print("MEC = ", MEC)
 
@@ -68,7 +68,7 @@ if AC.BADAFamily.BADA4:
 
     # optimum flight altitude at given M speed
     M = MRC
-    optAlt = AC.OPT.optAltitude(M=M, mass=mass, DeltaTemp=DeltaTemp)
+    optAlt = AC.OPT.optAltitude(M=M, mass=mass, deltaTemp=deltaTemp)
     print("optAlt =", optAlt)
 
     optAlt_precomputed = AC.OPT.getOPTParam("OPTALT", M, mass)
@@ -83,31 +83,31 @@ if AC.BADAFamily.BADAH:
     mass = 1600  # [kg] AC weight
     Hp = 14000  # [ft] AC flight altitude
     h = conv.ft2m(Hp)  # [m] AC flight altitude
-    DeltaTemp = 20  # [K] temperature deviation from ISA
+    deltaTemp = 20  # [K] temperature deviation from ISA
     wS = 0  # [m s^-1] longitudinal wind speed
 
     [theta, delta, sigma] = atm.atmosphereProperties(
-        h=h, DeltaTemp=DeltaTemp
+        h=h, deltaTemp=deltaTemp
     )  # atmoshpere properties
 
     # Maximum Range Cruise (MRC) Mach speed
-    MRC = AC.OPT.MRC(h=h, mass=mass, DeltaTemp=DeltaTemp, wS=wS)
+    MRC = AC.OPT.MRC(h=h, mass=mass, deltaTemp=deltaTemp, wS=wS)
     # print("MRC = ", conv.ms2kt(MRC))
     print("MRC = ", (MRC))
 
-    MRC_precomputed = AC.OPT.getOPTParam("MRC", Hp, mass, DeltaTemp)
+    MRC_precomputed = AC.OPT.getOPTParam("MRC", Hp, mass, deltaTemp)
     print("MRC_precomputed = ", conv.kt2ms(MRC_precomputed))
 
     # Long Range Cruise (LRC) Mach speed
-    LRC = AC.OPT.LRC(h=h, mass=mass, DeltaTemp=DeltaTemp, wS=wS)
+    LRC = AC.OPT.LRC(h=h, mass=mass, deltaTemp=deltaTemp, wS=wS)
     print("LRC = ", (LRC))
 
-    LRC_precomputed = AC.OPT.getOPTParam("LRC", Hp, mass, DeltaTemp)
+    LRC_precomputed = AC.OPT.getOPTParam("LRC", Hp, mass, deltaTemp)
     print("LRC_precomputed = ", conv.kt2ms(LRC_precomputed))
 
     # Maximum Endurance Cruise (MEC) Mach speed
-    MEC = AC.OPT.MEC(h=h, mass=mass, DeltaTemp=DeltaTemp, wS=wS)
+    MEC = AC.OPT.MEC(h=h, mass=mass, deltaTemp=deltaTemp, wS=wS)
     print("MEC = ", (MEC))
 
-    MEC_precomputed = AC.OPT.getOPTParam("MEC", Hp, mass, DeltaTemp)
+    MEC_precomputed = AC.OPT.getOPTParam("MEC", Hp, mass, deltaTemp)
     print("MEC_precomputed = ", conv.kt2ms(MEC_precomputed))