openap 2.4__tar.gz → 2.5.0__tar.gz

{openap-2.4 → openap-2.5.0}/.github/workflows/build-publish.yml

@@ -1,11 +1,14 @@
 name: build and publish
 
 on:
-  release:
-    types:
-      - published
+  push:
+    tags:
+      - "v*"
   workflow_dispatch:
 
+permissions:
+  contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -30,4 +33,9 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN_OPENAP }}
+          password: ${{ secrets.PYPI_API_TOKEN_OPENAP }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

{openap-2.4 → openap-2.5.0}/.gitignore

@@ -1,4 +1,5 @@
 tmp
+.venv
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -94,4 +95,4 @@ ENV/
 
 
 #vs code
-.vscode
+.vscode

{openap-2.4 → openap-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openap
-Version: 2.4
+Version: 2.5.0
 Summary: Open Aircraft Performance Model (OpenAP) in Python
 Project-URL: homepage, https://openap.dev
 Project-URL: repository, https://github.com/junzis/openap
@@ -15,17 +15,30 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
-Requires-Dist: matplotlib>=3.1
-Requires-Dist: numpy>=1.24
-Requires-Dist: pandas>=1.2
-Requires-Dist: pyyaml>=5.1
-Requires-Dist: scipy>=1.7
+Requires-Python: >=3.11
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: numpy>=2.1
+Requires-Dist: pandas>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: scipy>=1.14
+Provides-Extra: all
+Requires-Dist: casadi>=3.6; extra == 'all'
+Requires-Dist: jax>=0.4; extra == 'all'
+Provides-Extra: casadi
+Requires-Dist: casadi>=3.6; extra == 'casadi'
+Provides-Extra: jax
+Requires-Dist: jax>=0.4; extra == 'jax'
 Description-Content-Type: text/markdown
 
 # OpenAP: Open Aircraft Performance Model and Toolkit
 
-This repository contains the OpenAP model data and Python packages for aircraft performance and emission calculations.
+[![PyPI version](https://img.shields.io/pypi/v/openap.svg)](https://pypi.org/project/openap/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/openap.svg)](https://pypi.org/project/openap/)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+Open-source aircraft performance model and toolkit for Python. Calculate aircraft performance, fuel consumption, and emissions for air transportation studies and simulations.
+
+**Requirements:** Python 3.11+
 
 ## 🕮 User Guide
 
@@ -73,17 +86,22 @@ The OpenAP Python library includes the following packages:
 - `phase`: Module provides `FlightPhase()` class for determining flight phases.
 - `gen`: Module provides `FlightGenerator()` class for trajectory generation.
 
-Examples:
+Example:
 
 ```python
 import openap
 
-openap.prop.aircraft("A320")
+# Get aircraft properties
+aircraft = openap.prop.aircraft("A320")
+print(aircraft["mtow"])  # max takeoff weight: 78000 (kg)
+
+# Calculate fuel flow during cruise
 fuelflow = openap.FuelFlow("A320")
-fuelflow.enroute(mass, tas, alt) # -> kg/s
+ff = fuelflow.enroute(mass=60000, tas=250, alt=30000)
+print(ff)  # fuel flow: 0.92 (kg/s)
 ```
 
-The input parameters can be scalar, list, or ndarray. Most of the OpenAP methods' parameters are in aeronautical units, such as knots, feet, feet/min. The mass is always in SI units, i.e., kilograms.
+**Units:** Input parameters can be scalar, list, or ndarray. Speeds are in knots, altitudes in feet, vertical rates in feet/min. Mass is in kilograms (SI).
 
 ### Add-ons
 
@@ -97,19 +115,40 @@ fuelflow = bada4.FuelFlow()
 
 The methods and attributes of `openap.addon.bada4.FuelFlow()` are the same as those of `openap.FuelFlow()`.
 
-## Symbolic Implementation for CasADi
+## Alternative Backends: CasADi and JAX
 
-The OpenAP model can also be used with the CasADi library for symbolic computations. The symbolic model is available in the `openap.casadi` package. For example, you can use the following code to create a symbolic model for fuel flow:
+OpenAP supports multiple computational backends beyond NumPy:
 
-```python
-from openap.casadi import FuelFlow
+- **CasADi**: For symbolic computations and optimization
+- **JAX**: For automatic differentiation and GPU acceleration
 
-fuelflow = FuelFlow()
+### Installation
+
+Install with optional backend support:
+
+```sh
+pip install openap[casadi]  # CasADi backend
+pip install openap[jax]     # JAX backend
+pip install openap[all]     # Both backends
 ```
 
-All the methods of `openap.casadi.FuelFlow()` are the same as those of `openap.FuelFlow()`, and they are now symbolic functions that can be used to compute fuel flow for given flight conditions in CasADi `DM`, `SX`, or `MX` types.
+### Usage
+
+```python
+# CasADi backend
+import openap.casadi as oc
+
+fuelflow = oc.FuelFlow("A320")
+fuelflow.enroute(mass, tas, alt)  # works with CasADi DM, SX, or MX types
+
+# JAX backend
+import openap.jax as oj
+
+fuelflow = oj.FuelFlow("A320")
+fuelflow.enroute(mass, tas, alt)  # works with JAX arrays
+```
 
-How did we implement this? When the `casadi` module is initiated, a metaclass is used to replace the `sci` function from `numpy`, which overrides all the `numpy` functions with `casadi` functions. For more details, check the `openap/casadi/__init__.py` code.
+The API is identical to the standard `openap` module. The backends are implemented using a protocol-based architecture in `openap/backends/`.
 
 ## Citing OpenAP
 

{openap-2.4 → openap-2.5.0}/README.md

@@ -1,6 +1,12 @@
 # OpenAP: Open Aircraft Performance Model and Toolkit
 
-This repository contains the OpenAP model data and Python packages for aircraft performance and emission calculations.
+[![PyPI version](https://img.shields.io/pypi/v/openap.svg)](https://pypi.org/project/openap/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/openap.svg)](https://pypi.org/project/openap/)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+
+Open-source aircraft performance model and toolkit for Python. Calculate aircraft performance, fuel consumption, and emissions for air transportation studies and simulations.
+
+**Requirements:** Python 3.11+
 
 ## 🕮 User Guide
 
@@ -48,17 +54,22 @@ The OpenAP Python library includes the following packages:
 - `phase`: Module provides `FlightPhase()` class for determining flight phases.
 - `gen`: Module provides `FlightGenerator()` class for trajectory generation.
 
-Examples:
+Example:
 
 ```python
 import openap
 
-openap.prop.aircraft("A320")
+# Get aircraft properties
+aircraft = openap.prop.aircraft("A320")
+print(aircraft["mtow"])  # max takeoff weight: 78000 (kg)
+
+# Calculate fuel flow during cruise
 fuelflow = openap.FuelFlow("A320")
-fuelflow.enroute(mass, tas, alt) # -> kg/s
+ff = fuelflow.enroute(mass=60000, tas=250, alt=30000)
+print(ff)  # fuel flow: 0.92 (kg/s)
 ```
 
-The input parameters can be scalar, list, or ndarray. Most of the OpenAP methods' parameters are in aeronautical units, such as knots, feet, feet/min. The mass is always in SI units, i.e., kilograms.
+**Units:** Input parameters can be scalar, list, or ndarray. Speeds are in knots, altitudes in feet, vertical rates in feet/min. Mass is in kilograms (SI).
 
 ### Add-ons
 
@@ -72,19 +83,40 @@ fuelflow = bada4.FuelFlow()
 
 The methods and attributes of `openap.addon.bada4.FuelFlow()` are the same as those of `openap.FuelFlow()`.
 
-## Symbolic Implementation for CasADi
+## Alternative Backends: CasADi and JAX
 
-The OpenAP model can also be used with the CasADi library for symbolic computations. The symbolic model is available in the `openap.casadi` package. For example, you can use the following code to create a symbolic model for fuel flow:
+OpenAP supports multiple computational backends beyond NumPy:
 
-```python
-from openap.casadi import FuelFlow
+- **CasADi**: For symbolic computations and optimization
+- **JAX**: For automatic differentiation and GPU acceleration
 
-fuelflow = FuelFlow()
+### Installation
+
+Install with optional backend support:
+
+```sh
+pip install openap[casadi]  # CasADi backend
+pip install openap[jax]     # JAX backend
+pip install openap[all]     # Both backends
 ```
 
-All the methods of `openap.casadi.FuelFlow()` are the same as those of `openap.FuelFlow()`, and they are now symbolic functions that can be used to compute fuel flow for given flight conditions in CasADi `DM`, `SX`, or `MX` types.
+### Usage
+
+```python
+# CasADi backend
+import openap.casadi as oc
+
+fuelflow = oc.FuelFlow("A320")
+fuelflow.enroute(mass, tas, alt)  # works with CasADi DM, SX, or MX types
+
+# JAX backend
+import openap.jax as oj
+
+fuelflow = oj.FuelFlow("A320")
+fuelflow.enroute(mass, tas, alt)  # works with JAX arrays
+```
 
-How did we implement this? When the `casadi` module is initiated, a metaclass is used to replace the `sci` function from `numpy`, which overrides all the `numpy` functions with `casadi` functions. For more details, check the `openap/casadi/__init__.py` code.
+The API is identical to the standard `openap` module. The backends are implemented using a protocol-based architecture in `openap/backends/`.
 
 ## Citing OpenAP
 

openap-2.5.0/openap/__init__.py

@@ -0,0 +1,34 @@
+from .aero import Aero
+from .backends import CasadiBackend, JaxBackend, NumpyBackend, get_backend
+from .geo import Geo
+from .drag import Drag
+from .emission import Emission
+from . import aero
+from .extra import filters, nav, statistics
+from . import geo
+from .fuel import FuelFlow
+from .gen import FlightGenerator
+from .kinematic import WRAP
+from .phase import FlightPhase
+from .thrust import Thrust
+
+__all__ = [
+    "WRAP",
+    "Aero",
+    "CasadiBackend",
+    "Drag",
+    "Emission",
+    "FlightGenerator",
+    "FlightPhase",
+    "FuelFlow",
+    "Geo",
+    "JaxBackend",
+    "NumpyBackend",
+    "Thrust",
+    "aero",
+    "filters",
+    "geo",
+    "get_backend",
+    "nav",
+    "statistics",
+]