pyBADA 0.1.0__tar.gz → 0.1.1__tar.gz

pybada-0.1.1/.github/workflows/sphinx.yml

@@ -0,0 +1,56 @@
+name: Publish updated version of the docs
+
+on:
+  push:
+    branches:
+      - main
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+  
+jobs:
+  build-docs:
+    name: Build HTML docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install .[dev]
+
+      - name: Run Sphinx build
+        run: |
+          cd docs
+          make html
+
+      - name: Upload Sphinx HTML documentation as artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html
+
+  deploy:
+    name: Deploy to GitHub pages
+    # Do not run this unless pushing to main.
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-docs
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pybada-0.1.1/.gitignore

@@ -0,0 +1,5 @@
+.idea
+__pycache__
+dist/
+docs/build
+env/

pybada-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+    - id: black
+      language_version: python3.12

{pybada-0.1.0 → pybada-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyBADA
-Version: 0.1.0
+Version: 0.1.1
 Summary: pyBADA
 Project-URL: Homepage, https://github.com/eurocontrol/pybada
 Author-email: Henrich Glaser-Opitz <henrich.glaser-opitz@eurocontrol.int>
@@ -15,11 +15,21 @@ Requires-Dist: pandas==2.2.3
 Requires-Dist: scipy==1.11.3
 Requires-Dist: simplekml==1.3.6
 Requires-Dist: xlsxwriter==3.2.0
+Provides-Extra: dev
+Requires-Dist: black==23.9.1; extra == 'dev'
+Requires-Dist: flake8==6.1.0; extra == 'dev'
+Requires-Dist: folium==0.17.0; extra == 'dev'
+Requires-Dist: matplotlib==3.9.2; extra == 'dev'
+Requires-Dist: pre-commit==3.8.0; extra == 'dev'
+Requires-Dist: sphinx-gallery==0.17.1; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == 'dev'
+Requires-Dist: sphinx==7.4.7; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # pyBADA
 
 <a href="https://github.com/eurocontrol/pybada/blob/main/LICENCE.txt"><img alt="License: EUPL" src="https://img.shields.io/badge/license-EUPL-3785D1.svg"></a>
+<a href="https://pypi.org/project/pyBADA"><img alt="Released on PyPi" src="https://img.shields.io/pypi/v/pyBADA.svg"></a>
 ![Python 3.12](https://img.shields.io/badge/Python-3.12-3776AB.svg?logo=python&logoColor=white)
 <a href="https://github.com/eurocontrol/pybada"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 
@@ -33,10 +43,12 @@ pip install pyBADA
 
 ## Examples
 
--   `file_parser`: example of BADA file parser and retrieval of some basic BADA parameters for all BADA3/4/H
--   `optimum_speed_altitude`: example of calculation of optimum speeds and altitude for BADA4 and BADAH aircraft
--   `ac_trajectory`: a simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft
--   `ac_trajectory_GPS`: an example of a simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft including geodesic calculations
+-   `file_parser`: BADA file parser and retrieval of some basic BADA parameters for all BADA3/4/H
+-   `BADAData`: loading complete BADA3 dataset and retrievel of a specific parameters for a specific aircraft
+-   `optimum_speed_altitude`: calculation of optimum speeds and altitude for BADA4 and BADAH aircraft
+-   `ac_trajectory`: simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft
+-   `ac_trajectory_GPS`: simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft including geodesic calculations
+-   `heli_trajectory`: simple, but complete helicopter trajectory for BADAH aircraft
 
 ## Development
 
@@ -46,8 +58,11 @@ python3 -m venv env
 source env/bin/activate
 # Install package in editable mode
 pip install -e .
-# Install a couple of packages for formatting and linting
-pip install -r requirements-dev.txt
+# Install a couple of packages for formatting, linting and building the docs
+pip install -e .[dev]
+# To build the docs
+cd docs
+make html
 ```
 
 ## License

{pybada-0.1.0 → pybada-0.1.1}/README.md

@@ -1,6 +1,7 @@
 # pyBADA
 
 <a href="https://github.com/eurocontrol/pybada/blob/main/LICENCE.txt"><img alt="License: EUPL" src="https://img.shields.io/badge/license-EUPL-3785D1.svg"></a>
+<a href="https://pypi.org/project/pyBADA"><img alt="Released on PyPi" src="https://img.shields.io/pypi/v/pyBADA.svg"></a>
 ![Python 3.12](https://img.shields.io/badge/Python-3.12-3776AB.svg?logo=python&logoColor=white)
 <a href="https://github.com/eurocontrol/pybada"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 
@@ -14,10 +15,12 @@ pip install pyBADA
 
 ## Examples
 
--   `file_parser`: example of BADA file parser and retrieval of some basic BADA parameters for all BADA3/4/H
--   `optimum_speed_altitude`: example of calculation of optimum speeds and altitude for BADA4 and BADAH aircraft
--   `ac_trajectory`: a simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft
--   `ac_trajectory_GPS`: an example of a simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft including geodesic calculations
+-   `file_parser`: BADA file parser and retrieval of some basic BADA parameters for all BADA3/4/H
+-   `BADAData`: loading complete BADA3 dataset and retrievel of a specific parameters for a specific aircraft
+-   `optimum_speed_altitude`: calculation of optimum speeds and altitude for BADA4 and BADAH aircraft
+-   `ac_trajectory`: simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft
+-   `ac_trajectory_GPS`: simple, but complete aircraft trajectory for BADA3 and BADA4 aircraft including geodesic calculations
+-   `heli_trajectory`: simple, but complete helicopter trajectory for BADAH aircraft
 
 ## Development
 
@@ -27,8 +30,11 @@ python3 -m venv env
 source env/bin/activate
 # Install package in editable mode
 pip install -e .
-# Install a couple of packages for formatting and linting
-pip install -r requirements-dev.txt
+# Install a couple of packages for formatting, linting and building the docs
+pip install -e .[dev]
+# To build the docs
+cd docs
+make html
 ```
 
 ## License

pybada-0.1.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pybada-0.1.1/docs/source/API_reference/TCL.rst

@@ -0,0 +1,7 @@
+TCL
+===
+
+.. automodule:: pyBADA.TCL
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/aircraft.rst

@@ -0,0 +1,7 @@
+Aircraft
+========
+
+.. automodule:: pyBADA.aircraft
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/atmosphere.rst

@@ -0,0 +1,7 @@
+Atmosphere
+==========
+
+.. automodule:: pyBADA.atmosphere
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/bada3.rst

@@ -0,0 +1,7 @@
+Bada3
+=====
+
+.. automodule:: pyBADA.bada3
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/bada4.rst

@@ -0,0 +1,7 @@
+Bada4
+=====
+
+.. automodule:: pyBADA.bada4
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/badaH.rst

@@ -0,0 +1,7 @@
+BadaH
+=====
+
+.. automodule:: pyBADA.badaH
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/configuration.rst

@@ -0,0 +1,7 @@
+Configuration
+=============
+
+.. automodule:: pyBADA.configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/constants.rst

@@ -0,0 +1,7 @@
+Constants
+=========
+
+.. automodule:: pyBADA.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/conversions.rst

@@ -0,0 +1,7 @@
+Conversions
+===========
+
+.. automodule:: pyBADA.conversions
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/flightTrajectory.rst

@@ -0,0 +1,7 @@
+FlightTrajectory
+================
+
+.. automodule:: pyBADA.flightTrajectory
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/geodesic.rst

@@ -0,0 +1,7 @@
+Geodesic
+========
+
+.. automodule:: pyBADA.geodesic
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/magnetic.rst

@@ -0,0 +1,7 @@
+Magnetic
+========
+
+.. automodule:: pyBADA.magnetic
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/API_reference/trajectoryPrediction.rst

@@ -0,0 +1,7 @@
+TrajectoryPrediction
+====================
+
+.. automodule:: pyBADA.trajectoryPrediction
+   :members:
+   :undoc-members:
+   :show-inheritance:

pybada-0.1.1/docs/source/architecture.rst

@@ -0,0 +1,11 @@
+Architecture
+============
+
+.. _architecture_figure:
+
+.. figure:: _static/pyBADA_architecture.png
+   :alt: Image description
+   :width: 80%
+   :align: center
+
+   Figure 1: pyBADA simplified Architecture.

pybada-0.1.1/docs/source/conf.py

@@ -0,0 +1,48 @@
+# Configuration file for the Sphinx documentation builder.
+
+import os
+import sys
+
+sys.path.append(os.path.abspath("../../src"))
+
+# -- Project information -----------------------------------------------------
+
+project = "pyBADA"
+author = "Henrich Glaser - Opitz"
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosummary",
+    "sphinx_gallery.gen_gallery",
+]
+
+sphinx_gallery_conf = {
+    "examples_dirs": "../../examples",  # Path to your example scripts
+    "gallery_dirs": "auto_examples",  # Path where to save generated output
+    "filename_pattern": "^((?!skip_).)*$",  # Only include scripts not starting with 'skip_'
+    "reset_modules_order": "after",  # Reset modules after each example
+    "run_stale_examples": True,  # Force re-execution of examples
+    "remove_config_comments": True,  # Clean up the code blocks
+    "capture_repr": ("_repr_html_",),
+    "default_thumb_file": os.path.abspath(
+        os.path.join(
+            os.path.dirname(__file__), "_static", "default_thumbnail.png"
+        )
+    ),
+}
+
+autosummary_generate = True
+templates_path = ["_templates"]
+exclude_patterns = []
+
+# add_module_names = False
+modindex_common_prefix = ["pyBADA."]
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

pybada-0.1.1/docs/source/history.rst

@@ -0,0 +1,9 @@
+History
+==================================
+
+pyBADA was initially conceived by Ramon Dalmau, Marc Melgosa, and Xavier Prats in 2018 [1]_ [2]_, for use in SESAR projects: 
+`Apache <https://www.sesarju.eu/projects/apache>`_ and 
+`R-WAKE <https://www.sesarju.eu/projects/r-wake>`_.
+
+.. [1] https://upcommons.upc.edu/bitstream/handle/2117/127485/SESAR+Innovation+Days+2018.pdf?sequence=1
+.. [2] https://upcommons.upc.edu/bitstream/handle/2117/127485/pyBADA-SIDs.pdf?sequence=2&isAllowed=y

pybada-0.1.1/docs/source/index.rst

@@ -0,0 +1,43 @@
+pyBADA documentation
+==================================
+
+pyBADA provides aircraft performance modelling, trajectory prediction and optimisation, and visualisation with BADA in Python.
+
+To get started:
+
+.. code-block:: bash
+
+    pip install pybada
+
+
+About BADA
+==========
+
+Efficient air traffic operations rely on the capability of air traffic management (ATM) systems to accurately predict aircraft trajectories. Likewise, ATM research and development activities require modelling and simulation tools capable of replicating real-life operations and aircraft performances as perfectly as possible.
+
+To enable modelling and simulation of aircraft trajectories, every aircraft in operation shall have a corresponding Aircraft Performance Model (APM).
+
+This is why EUROCONTROL, in cooperation with aircraft manufacturers and operating airlines, has created and maintains an APM called BADA (Base of Aircraft Data).
+
+Owning to this cooperation, BADA prevails as a unique product provided by EUROCONTROL to the aviation community worldwide
+
+BADA APM is based on a kinetic approach to aircraft performance modelling. It is made of two components: the Model specifications, which provide the theoretical fundaments used to calculate aircraft performance parameters, and the Datasets containing the aircraft-specific coefficients necessary to perform calculations. 
+
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   pyBADA
+   architecture
+   userManual
+   history
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pybada-0.1.1/docs/source/pyBADA.rst

@@ -0,0 +1,19 @@
+API reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   API_reference/aircraft
+   API_reference/atmosphere
+   API_reference/bada3
+   API_reference/bada4
+   API_reference/badaH
+   API_reference/configuration
+   API_reference/constants
+   API_reference/conversions
+   API_reference/flightTrajectory
+   API_reference/geodesic
+   API_reference/magnetic
+   API_reference/TCL
+   API_reference/trajectoryPrediction

pybada-0.1.1/docs/source/userManual.rst

@@ -0,0 +1,8 @@
+User Manual
+===========
+  
+.. toctree::
+   :maxdepth: 1
+
+   user_manual/introduction
+   user_manual/examples

pybada-0.1.1/docs/source/user_manual/examples.rst

@@ -0,0 +1,8 @@
+Examples
+========
+   
+.. toctree::
+   :maxdepth: 2
+   :caption: Examples:
+
+   ../auto_examples/index

pybada-0.1.1/docs/source/user_manual/introduction.rst

@@ -0,0 +1,56 @@
+Introduction
+============
+
+Identification
+--------------
+PyBADA is a Python-based implementation of BADA APM for aircraft performance modelling, trajectory prediction and optimisation with BADA, including methods to calculate any of the aircraft’s performance characteristics (lift, drag, thrust, and fuel flow), operational flight envelope, BADA airline procedure model and calculation of PTF and PTD files, as defined by the BADA User Manual. It includes modules to calculate atmospheric properties, unit conversions (including the speed conversion) and basic geodesic calculations.
+
+PyBADA offers a full implementation of BADA3, BADA4 and BADAH. 
+
+The complete implementation then builds on top of BADA performance calculation by providing several trajectory segment calculations for all phases of flight (cruise, climb and descend) including acceleration and deceleration computation.
+
+EUROCONTROL is the owner of pyBADA
+
+Purpose
+-------
+PyBADA library has been created with several use cases in mind:
+
+- Help users starting with BADA and aircraft performance modelling to better understand how such a model can be implemented
+- Lower the workload of users planning to implement BADA in their tools, by reusing an already exiting fully functional library;
+- Minimizing the errors and unnecessary mistakes while implementing BADA performance calculations;
+- Help users who are building their own tools to validate the results against the library implemented and validated by the BADA team at EUROCONTROL;
+- Provide a starting platform for research organisations and universities, to build new and interesting tools utilizing BADA performance modelling, without requiring too much time to be spent on BADA implementation, and rather focusing on the research part.
+
+Glossary of Acronyms
+--------------------
+
+.. list-table:: Glossary of Acronyms
+   :widths: 15 85
+   :header-rows: 1
+
+   * - Acronym
+     - Explanation
+   * - ARPM
+     - Airline Procedure Model
+   * - BADA
+     - Base of Aircraft Data
+   * - BADA3
+     - Base of Aircraft Data Family 3
+   * - BADA4
+     - Base of Aircraft Data Family 4
+   * - BADAH
+     - Base of Aircraft Data Family H
+   * - PTD
+     - Performance Table Data
+   * - PTF
+     - Performance Table File
+   * - pyBADA
+     - Python Implementation of BADA
+   * - SW
+     - Software
+   * - TAS
+     - True Air Speed
+   * - TBP
+     - Turboprop
+   * - TCL
+     - Trajectory Computation Light

{pybada-0.1.0 → pybada-0.1.1}/examples/BADAData.py

@@ -1,11 +1,13 @@
 """
+BADA Data Retrieval
+===================
+
 Example of BADA parametes retrieval for specific aircraft
 """
 
 from pyBADA.bada3 import Bada3Aircraft
 from pyBADA.bada3 import Parser as Bada3Parser
 
-
 badaVersion = "DUMMY"
 
 # loading all the BADA data into a dataframe
@@ -21,7 +23,9 @@ print(params)
 print("\n")
 
 params = Bada3Parser.getBADAParameters(
-    df=allData, acName=["B737"], parameters=["VMO", "MMO", "MTOW", "engineType"]
+    df=allData,
+    acName=["B737"],
+    parameters=["VMO", "MMO", "MTOW", "engineType"],
 )
 print(params)
 print("\n")
@@ -32,5 +36,8 @@ params = Bada3Parser.getBADAParameters(
 print(params)
 print("\n")
 
-params = Bada3Parser.getBADAParameters(df=allData, acName="DA42", parameters="VMO")
+params = Bada3Parser.getBADAParameters(
+    df=allData, acName="DA42", parameters="VMO"
+)
 print(params)
+print("\n")

pybada-0.1.1/examples/GALLERY_HEADER.rst

@@ -0,0 +1,8 @@
+Examples Gallery
+================
+
+Welcome to the pyBADA Examples Gallery!
+
+This gallery showcases example scripts demonstrating the usage of the pyBADA package. The examples cover various functionalities and use cases to help you understand how to implement pyBADA in your projects.
+
+Below you will find a collection of scripts with accompanying explanations and outputs.