openap 1.4__tar.gz → 2.0__tar.gz

{openap-1.4 → openap-2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openap
-Version: 1.4
+Version: 2.0
 Summary: Open Aircraft Performance Model (OpenAP) in Python
 Home-page: https://openap.dev
 License: GNU Lesser General Public License v3 (LGPLv3)
@@ -9,6 +9,8 @@ Author-email: j.sun-1@tudelft.nl
 Requires-Python: >=3.9
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
@@ -21,7 +23,6 @@ Requires-Dist: matplotlib (>=3.1)
 Requires-Dist: numpy (>=1.24)
 Requires-Dist: pandas (>=1.2)
 Requires-Dist: pyyaml (>=5.1)
-Requires-Dist: scikit-fuzzy (>=0.4)
 Requires-Dist: scipy (>=1.7)
 Project-URL: Repository, https://github.com/junzis/openap
 Description-Content-Type: text/markdown
@@ -30,23 +31,10 @@ Description-Content-Type: text/markdown
 
 This repository contains the OpenAP model data and Python packages for aircraft performance and emission calculations.
 
-More information on user guide and related articles at: [OpenAP.dev](https://openap.dev/)
-
-The most recent development fork of OpenAP is: https://github.com/junzis/openap. For discussions and issues, you can use the following links:
-
- - https://github.com/junzis/openap/discussions (discussions, feedback and suggestions)
- - https://github.com/junzis/openap/issues (bug reporting)
-
+More information on the user guide and related articles at: [OpenAP.dev](https://openap.dev/)
 
 ## Install
 
-
-Install the development branch from GitHub:
-
-```sh
-pip install --upgrade git+https://github.com/junzis/openap
-```
-
 Install the latest stable release from pypi:
 
 ```sh
@@ -59,39 +47,40 @@ Install the latest stable release on conda-forge:
 conda install openap
 ```
 
-## Content
+Install the development branch from GitHub (may not be stable):
 
-OpenAP library has two parts, which are __OpenAP model data__ and __OpenAP Python packages__.
+```sh
+pip install --upgrade git+https://github.com/junzis/openap
+```
 
+## Content
 
 ### Model data
 
 Data in this repository includes:
 
-  - Aircraft data: Collected from open literature.
-  - Engines data: Primarily from ICAO emission data-bank, including fuel flow and emissions.
-  - Drag polar data: Exclusively derived from open data ([reference](https://junzis.com/files/openap_dragpolar.pdf)).
-  - Kinematic data: Kinematic model (formally [WRAP](https://github.com/junzis/wrap)) describe speed, altitude, and vertical rate.
-  - Navigation data: Airport and waypoints obtained from [X-plane ](https://developer.x-plane.com/docs/data-development-documentation/).
-
+- Aircraft data: Collected from open literature.
+- Engines data: Primarily from the ICAO emission data-bank, including fuel flow and emissions.
+- Drag polar model data: Exclusively derived from open data ([reference](https://research.tudelft.nl/files/71038050/published_OpenAP_drag_polar.pdf)).
+- Fuel mode data: Polynomial models derived from the [acropole model](https://github.com/DGAC/Acropole) by [@JarryGabriel](https://github.com/JarryGabriel).
+- Kinematic data: The kinematic model describes speed, altitude, and vertical rate ([reference](https://github.com/junzis/wrap)).
+- Navigation data: Airport and waypoints obtained from [X-Plane](https://developer.x-plane.com/docs/data-development-documentation/).
 
 ### Python packages
 
 The OpenAP Python library includes the following packages:
 
-  - `prop`: a package for accessing aircraft and engine properties
-  - `thrust`: a package for computing aircraft thrust
-  - `drag`: a package for computing aircraft drag
-  - `fuel`: a package for computing fuel consumption
-  - `emission`: a package for computing aircraft emissions
-  - `kinematic`: a package for accessing WRAP data
-  - `aero`: a package for common aeronautical conversions
-  - `nav`: a package for accessing navigation information
-  - `segment`: a package for determining climb, cruise, descent, level flight
-  - `phase`: a wrapper around `segment`, providing identification of all flight phases
-  - `traj`: package contains a set of tools for trajectory generation
-
-
+- `prop`: module for accessing aircraft and engine properties
+- `thrust`: module for computing aircraft thrust
+- `drag`: module for computing aircraft drag
+- `fuel`: module for computing fuel consumption
+- `emission`: module for computing aircraft emissions
+- `kinematic`: module for accessing WRAP data
+- `aero`: module for common aeronautical conversions
+- `nav`: module for accessing navigation information
+- `segment`: module for determining climb, cruise, descent, level flight
+- `phase`: module providing identification of all flight phases
+- `traj`: module contains a set of tools for trajectory generation
 
 ## Citing OpenAP
 

openap-2.0/README.md

@@ -0,0 +1,69 @@
+# Open Aircraft Performance Model (OpenAP) and Toolkit
+
+This repository contains the OpenAP model data and Python packages for aircraft performance and emission calculations.
+
+More information on the user guide and related articles at: [OpenAP.dev](https://openap.dev/)
+
+## Install
+
+Install the latest stable release from pypi:
+
+```sh
+pip install --upgrade openap
+```
+
+Install the latest stable release on conda-forge:
+
+```sh
+conda install openap
+```
+
+Install the development branch from GitHub (may not be stable):
+
+```sh
+pip install --upgrade git+https://github.com/junzis/openap
+```
+
+## Content
+
+### Model data
+
+Data in this repository includes:
+
+- Aircraft data: Collected from open literature.
+- Engines data: Primarily from the ICAO emission data-bank, including fuel flow and emissions.
+- Drag polar model data: Exclusively derived from open data ([reference](https://research.tudelft.nl/files/71038050/published_OpenAP_drag_polar.pdf)).
+- Fuel mode data: Polynomial models derived from the [acropole model](https://github.com/DGAC/Acropole) by [@JarryGabriel](https://github.com/JarryGabriel).
+- Kinematic data: The kinematic model describes speed, altitude, and vertical rate ([reference](https://github.com/junzis/wrap)).
+- Navigation data: Airport and waypoints obtained from [X-Plane](https://developer.x-plane.com/docs/data-development-documentation/).
+
+### Python packages
+
+The OpenAP Python library includes the following packages:
+
+- `prop`: module for accessing aircraft and engine properties
+- `thrust`: module for computing aircraft thrust
+- `drag`: module for computing aircraft drag
+- `fuel`: module for computing fuel consumption
+- `emission`: module for computing aircraft emissions
+- `kinematic`: module for accessing WRAP data
+- `aero`: module for common aeronautical conversions
+- `nav`: module for accessing navigation information
+- `segment`: module for determining climb, cruise, descent, level flight
+- `phase`: module providing identification of all flight phases
+- `traj`: module contains a set of tools for trajectory generation
+
+## Citing OpenAP
+
+```
+@article{sun2020openap,
+  title={OpenAP: An open-source aircraft performance model for air transportation studies and simulations},
+  author={Sun, Junzi and Hoekstra, Jacco M and Ellerbroek, Joost},
+  journal={Aerospace},
+  volume={7},
+  number={8},
+  pages={104},
+  year={2020},
+  publisher={Multidisciplinary Digital Publishing Institute}
+}
+```

{openap-1.4 → openap-2.0}/openap/__init__.py

@@ -1,11 +1,7 @@
-from .extra import aero
-from .extra import nav
-from .extra import filters
-from .extra import statistics
-
-from .thrust import Thrust
 from .drag import Drag
-from .fuel import FuelFlow
 from .emission import Emission
+from .extra import aero, filters, nav, statistics
+from .fuel import FuelFlow
 from .kinematic import WRAP
 from .phase import FlightPhase
+from .thrust import Thrust

{openap-1.4 → openap-2.0}/openap/casadi/aero_override.py

@@ -1,8 +1,8 @@
 """aero.py adapted for CasADi"""
 
 from casadi import casadi
-from . import numpy_override as np
 
+from . import numpy_override as np
 
 """Aero and Geo Constants """
 kts = 0.514444  # knot -> m/s
@@ -39,10 +39,14 @@ def atmos(h):
             Air pressure (Pa), density (kg/m3), and temperature (K).
 
     """
-    T = np.maximum(288.15 - 0.0065 * h, 216.65)
-    rhotrop = 1.225 * (T / 288.15) ** 4.256848030018761
-    dhstrat = np.maximum(0.0, h - 11000.0)
-    rho = rhotrop * np.exp(-dhstrat / 6341.552161)
+    # T = np.maximum(288.15 - 0.0065 * h, 216.65)
+    # rhotrop = 1.225 * (T / 288.15) ** 4.256848030018761
+    # dhstrat = np.maximum(0.0, h - 11000.0)
+    # rho = rhotrop * np.exp(-dhstrat / 6341.552161)
+
+    # use exponential model to avoid discontinuity at tropopause
+    T = 85.46369268 * np.exp(-0.00017235 * h) + 213.31449979
+    rho = 1.31788377 * np.exp(-0.00011107 * h) - 0.03933069
     p = rho * R * T
     return p, rho, T
 

{openap-1.4 → openap-2.0}/openap/data/aircraft/_synonym.csv

@@ -1,8 +1,7 @@
 orig,new
 a124,b744
 a306,a332
-a310,a319
-a318,a319
+a310,a318
 at72,e145
 at75,e145
 at76,e145

openap-2.0/openap/data/aircraft/a19n.yml

@@ -0,0 +1,58 @@
+aircraft: Airbus A319neo
+
+mtow: 75500
+mlw: 62500
+oew: 42600
+mfc: 29700
+vmo: 350
+mmo: 0.82
+ceiling: 12500
+
+pax:
+  max: 160
+  low: 120
+  high: 150
+
+fuselage:
+  length: 33.84
+  height: 4.14
+  width: 3.95
+
+wing:
+  area: 124
+  span: 35.8
+  mac: 4.29
+  sweep: 25
+  t/c: null
+
+flaps:
+  type: single-slotted
+  area: 21.1
+  bf/b: 0.780
+  lambda_f: 0.900 #a20n
+  cf/c: 0.176 #a20n
+  Sf/S: 0.170 #a20n
+
+cruise:
+  height: 11000
+  mach: 0.78
+
+engine:
+  type: turbofan
+  mount: wing
+  number: 2
+  default: PW1124G1-JM
+  options:
+    A319-171N: PW1124G1-JM
+    A319-151N: LEAP-1A24
+    A319-153N: LEAP-1A26
+
+drag:
+  cd0: 0.017 #a20n
+  k: 0.038 #a20n
+  e: 0.807 #a20n
+  gears: 0.017 #a20n
+
+fuel:
+  engine: V2524-A5 #a319
+  fuel_coef: 2.33357287 #a319

openap-2.0/openap/data/aircraft/a20n.yml

@@ -0,0 +1,62 @@
+aircraft: Airbus A320neo
+
+mtow: 79000
+mlw: 66000
+oew: 44300
+mfc: 29700
+vmo: 350
+mmo: 0.82
+ceiling: 12500
+
+pax:
+  max: 194
+  low: 150
+  high: 180
+
+fuselage:
+  length: 37.57
+  height: 4.14
+  width: 3.95
+
+wing:
+  area: 124
+  span: 35.8
+  mac: 4.29
+  sweep: 25
+  t/c: null
+
+flaps:
+  type: single-slotted
+  area: 21.1
+  bf/b: 0.780
+  lambda_f: 0.900
+  cf/c: 0.176
+  Sf/S: 0.170
+
+cruise:
+  height: 11000
+  mach: 0.78
+
+engine:
+  type: turbofan
+  mount: wing
+  number: 2
+  default: PW1127G-JM
+  options:
+    A320-271N: PW1127G-JM
+    A320-272N: PW1124G1-JM
+    A320-273N: PW1129G-JM
+    A320-251N: LEAP-1A26
+    A320-252N: LEAP-1A24
+    A320-253N: LEAP-1A29
+
+drag:
+  cd0: 0.017
+  k: 0.038
+  e: 0.807
+  gears: 0.017
+
+fuel:
+  aircraft: Airbus A320
+  engine: CFM56-5B4/P
+  fuel_coef: 2.65942225

openap-2.0/openap/data/aircraft/a21n.yml

@@ -0,0 +1,60 @@
+aircraft: Airbus A321neo
+
+mtow: 97000
+mlw: 77800
+oew: 50000
+mfc: 33000
+vmo: 350
+mmo: 0.82
+ceiling: 12500
+
+pax:
+  max: 244
+  low: 180
+  high: 220
+
+fuselage:
+  length: 44.51
+  height: 4.14
+  width: 3.95
+
+wing:
+  area: 128
+  span: 35.8
+  mac: 4.29
+  sweep: 25
+  t/c: null
+
+flaps:
+  type: double-slotted
+  area: 21.1
+  bf/b: 0.780
+  lambda_f: 0.900 #a20n
+  cf/c: 0.176 #a20n
+  Sf/S: 0.170 #a20n
+
+cruise:
+  height: 11000
+  mach: 0.78
+
+engine:
+  type: turbofan
+  mount: wing
+  number: 2
+  default: PW1133G-JM
+  options:
+    A321-271N: PW1133G-JM
+    A321-272N: PW1130G-JM
+    A321-251N: LEAP-1A32
+    A321-252N: LEAP-1A30
+    A321-253N: LEAP-1A33
+
+drag:
+  cd0: 0.017 #a20n
+  k: 0.038 #a20n
+  e: 0.807 #a20n
+  gears: 0.017 #a20n
+
+fuel:
+  engine: CFM56-5B4/P #a320
+  fuel_coef: 2.65942225 #a320

openap-2.0/openap/data/aircraft/a318.yml

@@ -0,0 +1,59 @@
+aircraft: Airbus A318
+
+mtow: 68000
+mlw: 57500
+oew: 39500
+mfc: 24210
+vmo: 350
+mmo: 0.82
+ceiling: 12500
+
+pax:
+  max: 136
+  low: 107
+  high: 117
+
+fuselage:
+  length: 31.44
+  height: 4.14
+  width: 3.95
+
+wing:
+  area: 122.4
+  span: 34.10
+  mac: 4.1935
+  sweep: 25
+  t/c: null
+
+flaps:
+  type: single-slotted
+  area: 21.1
+  bf/b: 0.780
+  lambda_f: 0.900 #a319
+  cf/c: 0.176 #a319
+  Sf/S: 0.170 #a319
+
+cruise:
+  height: 11000
+  mach: 0.78
+
+engine:
+  type: turbofan
+  mount: wing
+  number: 2
+  default: CFM56-5B9
+  options:
+    A318-111: CFM56-5B8
+    A318-112: CFM56-5B9
+    A318-121: PW6122A
+    A318-122: PW6124A
+
+drag:
+  cd0: 0.020 #a319
+  k: 0.039 #a319
+  e: 0.783 #a319
+  gears: 0.017 #a319
+
+fuel:
+  engine: CFM56-5B9/3
+  fuel_coef: 2.03114004

openap-2.0/openap/data/aircraft/a319.yml

@@ -0,0 +1,63 @@
+aircraft: Airbus A319
+
+mtow: 75500
+mlw: 62500
+oew: 40800
+mfc: 30190
+vmo: 350
+mmo: 0.82
+ceiling: 12500
+
+pax:
+  max: 156
+  low: 110
+  high: 140
+
+fuselage:
+  length: 33.84
+  height: 4.14
+  width: 3.95
+
+wing:
+  area: 124
+  span: 35.8
+  mac: 4.1935
+  sweep: 25
+  t/c: null
+
+flaps:
+  type: single-slotted
+  area: 21.1
+  bf/b: 0.780
+  lambda_f: 0.900
+  cf/c: 0.176
+  Sf/S: 0.170
+
+cruise:
+  height: 11000
+  mach: 0.78
+
+engine:
+  type: turbofan
+  mount: wing
+  number: 2
+  default: CFM56-5B7
+  options:
+    A319-111: CFM56-5B5
+    A319-112: CFM56-5B6
+    A319-113: CFM56-5A4
+    A319-114: CFM56-5A5
+    A319-115: CFM56-5B7
+    A319-131: V2522-A5
+    A319-132: V2524-A5
+    A319-133: V2527M-A5
+
+drag:
+  cd0: 0.020
+  k: 0.039
+  e: 0.783
+  gears: 0.017
+
+fuel:
+  engine: V2524-A5
+  fuel_coef: 2.33357287

openap-2.0/openap/data/aircraft/a320.yml

@@ -0,0 +1,64 @@
+aircraft: Airbus A320
+
+mtow: 78000
+mlw: 66000
+oew: 42600
+mfc: 24210
+vmo: 350
+mmo: 0.82
+ceiling: 12500
+
+pax:
+  max: 180
+  low: 140
+  high: 170
+
+fuselage:
+  length: 37.57
+  height: 4.14
+  width: 3.95
+
+wing:
+  area: 124
+  span: 35.8
+  mac: 4.1935
+  sweep: 25
+  t/c: null
+
+flaps:
+  type: single-slotted
+  area: 21.1
+  bf/b: 0.780
+  lambda_f: 0.900
+  cf/c: 0.176
+  Sf/S: 0.170
+
+cruise:
+  height: 11000
+  mach: 0.78
+
+engine:
+  type: turbofan
+  mount: wing
+  number: 2
+  default: CFM56-5B4
+  options:
+    A320-111: CFM56-5-A1
+    A320-211: CFM56-5-A1
+    A320-212: CFM56-5A3
+    A320-214: CFM56-5B4
+    A320-215: CFM56-5B5
+    A320-216: CFM56-5B6
+    A320-231: V2500-A1
+    A320-232: V2527-A5
+    A320-233: V2527E-A5
+
+drag:
+  cd0: 0.018
+  k: 0.039
+  e: 0.799
+  gears: 0.017
+
+fuel:
+  engine: CFM56-5B4/P
+  fuel_coef: 2.65942225

openap-2.0/openap/data/aircraft/a321.yml

@@ -0,0 +1,63 @@
+aircraft: Airbus A321
+
+mtow: 93500
+mlw: 77800
+oew: 48500
+mfc: 30030
+vmo: 350
+mmo: 0.82
+ceiling: 12500
+
+pax:
+  max: 220
+  low: 170
+  high: 210
+
+fuselage:
+  length: 44.51
+  height: 4.14
+  width: 3.95
+
+wing:
+  area: 128
+  span: 35.8
+  mac: 4.1935
+  sweep: 25
+  t/c: null
+
+flaps:
+  type: double-slotted
+  area: 21.1
+  bf/b: 0.780
+  lambda_f: 0.900
+  cf/c: 0.176
+  Sf/S: 0.165
+
+cruise:
+  height: 11000
+  mach: 0.78
+
+engine:
+  type: turbofan
+  mount: wing
+  number: 2
+  default: CFM56-5B1
+  options:
+    A321-111: CFM56-5B1
+    A321-112: CFM56-5B2
+    A321-131: V2530-A5
+    A321-211: CFM56-5B3
+    A321-212: CFM56-5B1
+    A321-213: CFM56-5B2
+    A321-231: V2533-A5
+    A321-232: V2530-A5
+
+drag:
+  cd0: 0.020
+  k: 0.041
+  e: 0.785
+  gears: 0.019
+
+fuel:
+  engine: V2533-A5
+  fuel_coef: 3.2375643