openap 1.2__tar.gz → 1.4__tar.gz

openap-1.4/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

openap-1.4/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: openap
+Version: 1.4
+Summary: Open Aircraft Performance Model (OpenAP) in Python
+Home-page: https://openap.dev
+License: GNU Lesser General Public License v3 (LGPLv3)
+Author: Junzi Sun
+Author-email: j.sun-1@tudelft.nl
+Requires-Python: >=3.9
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+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
+
+# 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 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)
+
+
+## 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
+pip install --upgrade openap
+```
+
+Install the latest stable release on conda-forge:
+
+```sh
+conda install openap
+```
+
+## Content
+
+OpenAP library has two parts, which are __OpenAP model data__ and __OpenAP Python packages__.
+
+
+### 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/).
+
+
+### 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
+
+
+
+## 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.2 → openap-1.4}/README.md

@@ -4,7 +4,10 @@ This repository contains the OpenAP model data and Python packages for aircraft
 
 More information on user guide and related articles at: [OpenAP.dev](https://openap.dev/)
 
-Use the [junzis/openap/discussions](https://github.com/junzis/openap/discussions) to provide your feedback/suggestions, and use [junzis/openap/issues](https://github.com/junzis/openap/issues) to report bugs.
+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)
 
 
 ## Install
@@ -22,7 +25,7 @@ Install the latest stable release from pypi:
 pip install --upgrade openap
 ```
 
-Install the latest stable release on conda-froge:
+Install the latest stable release on conda-forge:
 
 ```sh
 conda install openap

{openap-1.2 → openap-1.4}/openap/casadi/__init__.py

@@ -26,11 +26,11 @@ class Thrust(thrust.Thrust, metaclass=RemoveDecoratorMeta):
 
 
 class FuelFlow(fuel.FuelFlow, metaclass=RemoveDecoratorMeta):
-    def __init__(self, ac, eng=None):
+    def __init__(self, ac, eng=None, **kwargs):
         self.Drag = Drag
         self.Thrust = Thrust
-        super(FuelFlow, self).__init__(ac=ac, eng=eng)
+        super(FuelFlow, self).__init__(ac=ac, eng=eng, **kwargs)
 
 
 class Emission(emission.Emission, metaclass=RemoveDecoratorMeta):
-    pass
+    pass

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

@@ -24,6 +24,9 @@ beta = -0.0065  # [K/m] ISA temp gradient below tropopause
 r_earth = 6371000.0  # m, average earth radius
 a0 = 340.293988  # m/s, sea level speed of sound ISA, sqrt(gamma*R*T0)
 
+deg = 180 / 3.14159  # radians -> degrees
+rad = 3.14159 / 180  # degrees -> radians
+
 
 def atmos(h):
     """Compute press, density and temperature at a given altitude.
@@ -116,10 +119,10 @@ def distance(lat1, lon1, lat2, lon2, h=0):
 
     """
     # convert decimal degrees to radians
-    lat1 = np.radians(lat1)
-    lon1 = np.radians(lon1)
-    lat2 = np.radians(lat2)
-    lon2 = np.radians(lon2)
+    lat1 = lat1 * rad
+    lon1 = lon1 * rad
+    lat2 = lat2 * rad
+    lon2 = lon2 * rad
 
     # haversine formula
     dlon = lon2 - lon1
@@ -143,14 +146,14 @@ def bearing(lat1, lon1, lat2, lon2):
         SX or MX: Bearing (in degrees). Between 0 and 360.
 
     """
-    lat1 = np.radians(lat1)
-    lon1 = np.radians(lon1)
-    lat2 = np.radians(lat2)
-    lon2 = np.radians(lon2)
+    lat1 = lat1 * rad
+    lon1 = lon1 * rad
+    lat2 = lat2 * rad
+    lon2 = lon2 * rad
     x = np.sin(lon2 - lon1) * np.cos(lat2)
     y = np.cos(lat1) * np.sin(lat2) - np.sin(lat1) * np.cos(lat2) * np.cos(lon2 - lon1)
     initial_bearing = np.arctan2(x, y)
-    initial_bearing = np.degrees(initial_bearing)
+    initial_bearing = initial_bearing * deg
     bearing = (initial_bearing + 360) % 360
     return bearing
 
@@ -195,9 +198,9 @@ def latlon(lat1, lon1, d, brg, h=0):
 
     """
     # convert decimal degrees to radians
-    lat1 = np.radians(lat1)
-    lon1 = np.radians(lon1)
-    brg = np.radians(brg)
+    lat1 = lat1 * rad
+    lon1 = lon1 * rad
+    brg = brg * rad
 
     # haversine formula
     lat2 = np.arcsin(
@@ -208,8 +211,8 @@ def latlon(lat1, lon1, d, brg, h=0):
         np.sin(brg) * np.sin(d / (r_earth + h)) * np.cos(lat1),
         np.cos(d / (r_earth + h)) - np.sin(lat1) * np.sin(lat2),
     )
-    lat2 = np.degrees(lat2)
-    lon2 = np.degrees(lon2)
+    lat2 = lat2 * deg
+    lon2 = lon2 * deg
     return lat2, lon2
 
 
@@ -356,7 +359,7 @@ def crossover_alt(v_cas, mach):
     """
     mach = 1e-4 if mach < 1e-4 else mach
     delta = ((0.2 * (v_cas / a0) ** 2 + 1) ** 3.5 - 1) / (
-        (0.2 * mach ** 2 + 1) ** 3.5 - 1
+        (0.2 * mach**2 + 1) ** 3.5 - 1
     )
     h = T0 / beta * (delta ** (-1 * R * beta / g0) - 1)
     return h

{openap-1.2 → openap-1.4}/openap/casadi/numpy_override.py

@@ -2,6 +2,7 @@ from numpy import *
 from casadi import *  # this override the previous
 
 # numpy functions -> casadi functions
+abs = casadi.fabs
 where = casadi.if_else
 maximum = casadi.fmax
 minimum = casadi.fmin

openap-1.4/openap/contrail.py

@@ -0,0 +1,120 @@
+# %%
+import numpy as np
+from scipy import optimize
+
+# %%
+gas_constant_water_vapor = 461.51
+gas_constant_dry_air = 287.05
+temperature_steam = 372.15
+pressure_steam = 101325
+temperature_ice_point = 273.16
+pressure_ice_point = 611.73
+
+ei_water = 1.2232
+spec_air_heat_capacity = 1004
+ratio_mass_water_vapor_air = 0.622
+spec_combustion_heat = 43e6
+propulsion_efficiency = 0.4  # variable
+
+
+def saturation_pressure_over_water(temperature):
+    # Murphy and Koop 2005
+    return np.exp(
+        54.842763
+        - 6763.22 / temperature
+        - 4.210 * np.log(temperature)
+        + 0.000367 * temperature
+        + np.tanh(0.0415 * (temperature - 218.8))
+        * (
+            53.878
+            - 1331.22 / temperature
+            - 9.44523 * np.log(temperature)
+            + 0.014025 * temperature
+        )
+    )
+
+
+def saturation_pressure_over_ice(temperature):
+    # Murphy and Koop 2005
+    return np.exp(
+        9.550426
+        - 5723.265 / temperature
+        + 3.53068 * np.log(temperature)
+        - 0.00728332 * temperature
+    )
+
+
+def relative_humidity(specific_humidity, pressure, temperature, to="ice"):
+    assert to in ("ice", "water")
+
+    if to == "ice":
+        saturation_pressure = saturation_pressure_over_ice(temperature)
+    else:
+        saturation_pressure = saturation_pressure_over_water(temperature)
+
+    return (
+        specific_humidity
+        * pressure
+        * (gas_constant_water_vapor / gas_constant_dry_air)
+        / saturation_pressure
+    )
+
+
+def critical_temperature_water(pressure):
+    isobaric_mixing_slope = (
+        ei_water
+        * spec_air_heat_capacity
+        * pressure
+        / (
+            ratio_mass_water_vapor_air
+            * spec_combustion_heat
+            * (1 - propulsion_efficiency)
+        )
+    )
+
+    crit_temp_water = (
+        -46.46
+        + 9.43 * np.log(isobaric_mixing_slope - 0.053)
+        + 0.72 * (np.log(isobaric_mixing_slope - 0.053)) ** 2
+        + 273.15
+    )
+
+    return crit_temp_water
+
+
+def critical_temperature_water_and_ice(pressure):
+    def func(temp_critical, crit_temp_water, isobaric_mixing_slope):
+        return (
+            saturation_pressure_over_water(crit_temp_water)
+            - saturation_pressure_over_ice(temp_critical)
+            - (crit_temp_water - temp_critical) * isobaric_mixing_slope
+        )
+
+    isobaric_mixing_slope = (
+        ei_water
+        * spec_air_heat_capacity
+        * pressure
+        / (
+            ratio_mass_water_vapor_air
+            * spec_combustion_heat
+            * (1 - propulsion_efficiency)
+        )
+    )
+
+    crit_temp_water = (
+        -46.46
+        + 9.43 * np.log(isobaric_mixing_slope - 0.053)
+        + 0.72 * (np.log(isobaric_mixing_slope - 0.053)) ** 2
+        + 273.15
+    )
+
+    sol = optimize.root_scalar(
+        func,
+        args=(crit_temp_water, isobaric_mixing_slope),
+        bracket=[100, crit_temp_water],
+        method="brentq",
+    )
+    # print(sol.root, sol.iterations, sol.function_calls)
+    crit_temp_ice = sol.root
+
+    return crit_temp_water, crit_temp_ice

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

@@ -2,6 +2,7 @@ orig,new
 a124,b744
 a306,a332
 a310,a319
+a318,a319
 at72,e145
 at75,e145
 at76,e145
@@ -14,10 +15,10 @@ c525,c550
 c56x,c550
 crj2,e145
 crj9,e75l
-dh8d,e145
 e290,e190
-lj45,c550
+glf5,glf6
+gl5t,glf6
+lj45,glf6
 md11,b773
 pc24,c550
-sf34,e145
 su95,e170

{openap-1.2 → openap-1.4}/openap/data/aircraft/a19n.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A319neo
 
+pax: 
+  max: 160
+  low: 120
+  high: 150
+
 fuselage:
   length:   33.84
   height:   4.14

{openap-1.2 → openap-1.4}/openap/data/aircraft/a20n.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A320neo
 
+pax: 
+  max: 194
+  low: 150
+  high: 180
+
 fuselage:
   length:   37.57
   height:   4.14

{openap-1.2 → openap-1.4}/openap/data/aircraft/a21n.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A321neo
 
+pax: 
+  max: 244
+  low: 180
+  high: 220
+
 fuselage:
   length:   44.51
   height:   4.14

{openap-1.2 → openap-1.4}/openap/data/aircraft/a319.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A319
 
+pax: 
+  max: 156
+  low: 110
+  high: 140
+
 fuselage:
   length:   33.84
   height:   4.14

{openap-1.2 → openap-1.4}/openap/data/aircraft/a320.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A320
 
+pax: 
+  max: 180
+  low: 140
+  high: 170
+
 fuselage:
   length:   37.57
   height:   4.14

{openap-1.2 → openap-1.4}/openap/data/aircraft/a321.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A321
 
+pax: 
+  max: 220
+  low: 170
+  high: 210
+
 fuselage:
   length:   44.51
   height:   4.14

{openap-1.2 → openap-1.4}/openap/data/aircraft/a332.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A330-200
 
+pax: 
+  max: 406
+  low: 220
+  high: 260
+
 fuselage:
   length:   58.82
   height:   5.64

{openap-1.2 → openap-1.4}/openap/data/aircraft/a333.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A330-300
 
+pax: 
+  max: 440
+  low: 250
+  high: 290
+
 fuselage:
   length:   63.67
   height:   5.64

{openap-1.2 → openap-1.4}/openap/data/aircraft/a343.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A340-300
 
+pax: 
+  max: 440
+  low: 250
+  high: 290
+
 fuselage:
   length:   63.69
   height:   5.64

{openap-1.2 → openap-1.4}/openap/data/aircraft/a359.yml

@@ -1,5 +1,11 @@
 aircraft: Airbus A350-900
 
+pax: 
+  max: 440
+  low: 300
+  high: 350
+
+
 fuselage:
   length:   66.8
   height:   6.09

{openap-1.2 → openap-1.4}/openap/data/aircraft/a388.yml

@@ -1,5 +1,10 @@
 aircraft: Airbus A380-800
 
+pax: 
+  max: 853
+  low: 410
+  high: 620
+
 fuselage:
   length:   72.72
   height:   8.41

{openap-1.2 → openap-1.4}/openap/data/aircraft/b37m.yml

@@ -1,5 +1,11 @@
 aircraft: Boeing 737 MAX 7
 
+pax: 
+  max: 172
+  low: 138
+  high: 153
+
+
 fuselage:
   length:   33.6
   height:   3.73