openap 2.2__tar.gz → 2.3__tar.gz

{openap-2.2 → openap-2.3}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: openap
-Version: 2.2
+Version: 2.3
 Summary: Open Aircraft Performance Model (OpenAP) in Python
 Project-URL: homepage, https://openap.dev
 Project-URL: repository, https://github.com/junzis/openap
 Project-URL: issues, https://github.com/junzis/openap/issues
-Author-email: Junzi Sun <j.sun-1@tudelft.nl>
+Author-email: Junzi Sun <git@junzis.com>
 License: GNU LGPL v3
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta

{openap-2.2 → openap-2.3}/examples/example_fuel_qar_data.ipynb

@@ -235,7 +235,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.11"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

{openap-2.2 → openap-2.3}/openap/addon/bada4.py

@@ -9,14 +9,14 @@ from ..extra import ndarrayconvert
 
 
 # %%
-def load_bada4(ac: str, path: str) -> ElementTree:
+def load_bada4(ac: str, path: str) -> ElementTree.ElementTree:
     """Find and construct the drag polar model.
     Args:
         ac (str): aircraft type (for example: A320 or A320-231).
         bada_path (str): path to BADA4 models.
 
     Returns:
-        xml.etree.ElementTree: BADA4 model XML.
+        xml.etree.ElementTree.ElementTree: BADA4 model XML.
     """
 
     ac_options = glob(f"{path}/{ac.upper()}*")

{openap-2.2 → openap-2.3}/openap/contrail.py

@@ -1,7 +1,8 @@
 # %%
-import numpy as np
 from scipy import optimize
 
+import numpy as np
+
 # %%
 gas_constant_water_vapor = 461.51
 gas_constant_dry_air = 287.05
@@ -60,6 +61,14 @@ def relative_humidity(specific_humidity, pressure, temperature, to="ice"):
     )
 
 
+def rhw2rhi(relative_humidity_water, temperature):
+    return (
+        relative_humidity_water
+        * saturation_pressure_over_water(temperature)
+        / saturation_pressure_over_ice(temperature)
+    )
+
+
 def critical_temperature_water(pressure):
     isobaric_mixing_slope = (
         ei_water

{openap-2.2 → openap-2.3}/openap/data/aircraft/a19n.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 7000
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a20n.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 6300
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a21n.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 7400
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a318.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 2800
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a319.yml

@@ -36,12 +36,13 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 3300
 
 engine:
   type: turbofan
   mount: wing
   number: 2
-  default: CFM56-5B7
+  default: V2524-A5
   options:
     A319-111: CFM56-5B5
     A319-112: CFM56-5B6

{openap-2.2 → openap-2.3}/openap/data/aircraft/a320.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 5000
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a321.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 4400
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a332.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.82
+  range: 12500
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a333.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.82
+  range: 10500
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a343.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.82
+  range: 13300
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a359.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.85
+  range: 15000
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/a388.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 12800
   mach: 0.85
+  range: 14800
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b37m.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 7100
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b38m.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.79
+  range: 6600
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b39m.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.79
+  range: 6600
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b3xm.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.79
+  range: 6100
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b734.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 3900
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b737.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 4600
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b738.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.789
+  range: 3700
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b739.yml

@@ -36,12 +36,13 @@ flaps:
 cruise:
   height: 11000
   mach: 0.79
+  range: 5100
 
 engine:
   type: turbofan
   mount: wing
   number: 2
-  default: CFM56-7B26
+  default: CFM56-7B27E
   options:
     - CFM56-7B24
     - CFM56-7B26

{openap-2.2 → openap-2.3}/openap/data/aircraft/b744.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.85
+  range: 13400
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b748.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.85
+  range: 14800
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b752.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.8
+  range: 7200
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b763.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.8
+  range: 11400
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b772.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.84
+  range: 9600
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b773.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.84
+  range: 11000
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b77w.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.84
+  range: 14700
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b788.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.85
+  range: 14800
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/b789.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.85
+  range: 14000
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/c550.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.67
+  range: 3500
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/e145.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.72
+  range: 2200
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/e170.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.75
+  range: 3900
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/e190.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.78
+  range: 4400
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/e195.yml

@@ -38,6 +38,7 @@ limits:
 cruise:
   height: 11000
   mach: 0.78
+  range: 4300
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/e75l.yml

@@ -36,6 +36,7 @@ flaps:
 cruise:
   height: 11000
   mach: 0.75
+  range: 3300
 
 engine:
   type: turbofan

{openap-2.2 → openap-2.3}/openap/data/aircraft/glf6.yml

@@ -37,6 +37,7 @@ flaps:
 cruise:
   height: 12000
   mach: 0.85
+  range: 13000
 
 engine:
   type: turbofan

openap-2.3/openap/mass.py

@@ -0,0 +1,37 @@
+import numpy as np
+
+from . import prop
+
+
+def from_range(typecode, distance, load_factor=0.8, fraction=False, **kwargs):
+    """Compute aircraft mass based on range, load factor, and fraction settings.
+
+    This function calculates the aircraft mass considering fuel and payload weights
+    based on the given flight distance and load factor.
+
+    Args:
+        typecode (str): ICAO aircraft type code (e.g. A320, B738)
+        distance (float): Flight distance in nautical miles
+        load_factor (float): Load factor between 0 and 1, default 0.8
+        fraction (bool): If True, return mass fraction of MTOW, default False
+
+    Returns:
+        float: Aircraft mass in kg, or mass fraction if fraction=True
+
+    """
+    ac = prop.aircraft(typecode, **kwargs)
+
+    range_fraction = distance / ac["cruise"]["range"]
+    range_fraction = np.clip(range_fraction, 0.2, 1)
+
+    max_fuel_weight = ac["mfc"] * 0.8025  # L->kg
+    fuel_weight = range_fraction * max_fuel_weight
+
+    payload_weight = (ac["mtow"] - max_fuel_weight - ac["oew"]) * load_factor
+
+    mass = ac["oew"] + fuel_weight + payload_weight
+
+    if fraction:
+        return mass / ac["mtow"]
+    else:
+        return mass

{openap-2.2 → openap-2.3}/pyproject.toml

@@ -1,8 +1,8 @@
 [project]
 name = "openap"
-version = "2.2"
+version = "2.3"
 description = "Open Aircraft Performance Model (OpenAP) in Python"
-authors = [{ name = "Junzi Sun", email = "j.sun-1@tudelft.nl" }]
+authors = [{ name = "Junzi Sun", email = "git@junzis.com" }]
 license = { text = "GNU LGPL v3" }
 readme = "README.md"
 classifiers = [

{openap-2.2 → openap-2.3}/scripts/build_fuel_model.py

@@ -204,6 +204,8 @@ for typecode in acropole_typecodes:
         ax1.plot(x, func(x, *popt), "r-", label=f"fit: {popt}")
         ax1.legend()
         ax1.set_xlim(0, 0.7)
+        ax1.set_xlabel("Thrust ratio")
+        ax1.set_ylabel("Fuel flow")
 
         ax2.scatter(df1.thrust_ratio, df1.fuel_flow, s=5, alpha=0.02, c="tab:green")
         ax2.scatter(df2.thrust_ratio, df2.fuel_flow, s=5, alpha=0.02, c="tab:orange")
@@ -212,6 +214,8 @@ for typecode in acropole_typecodes:
         ax2.scatter(df5.thrust_ratio, df5.fuel_flow, s=5, alpha=0.02, c="gray")
         ax2.plot(x, func(x, *popt), "r-")
         ax2.set_xlim(0, 0.7)
+        ax2.set_xlabel("Thrust ratio")
+        ax2.set_ylabel("Fuel flow")
 
         plt.suptitle(typecode)
         plt.tight_layout()
@@ -284,6 +288,8 @@ print("default", popt)
 
 x = np.linspace(0, 1, 100)
 plt.plot(x, func(x, *popt), "b-")
+plt.xlabel("Thrust ratio")
+plt.ylabel("Fuel flow")
 
 
 plt.legend(ncol=3)