missing installation/configuration instructions

[espinielli]

I am not able to find out how pyBADA needs to be installed/configured to point to a local BADA installation.
From the code it looks like it is searching for the relevant BADA files but I could not find out in README or elsewhere where to specify their location.

[avivace]

Thanks for bringing this up @espinielli , we're on it

[avivace]

Ciao @espinielli ! We updated the docs with a small paragraph explaining how to load BADA models from disk. Could you check https://eurocontrol.github.io/pybada/getting-started.html#providing-custom-models and provide us some feedback?

[espinielli]

It is a good start...but I would suggest something more and simpler.
(These are just my observations, discard them eventually)

I would add in the Getting Started

1. a very short snippet of pyBADA code to show the functionality.
   This would assume a certain setup for the BADA installation (see suggestion for config file)
2. BADA installation instructions with a concrete example going from downloaded ZIPs

So for example, something like:

BADA Installation and configuration for pyBADA

Assuming you got an approved license for the use of BADA, the following steps detail how to install BADA & configure pyBADA:

1. In the BADA User Interface select the version of interest, say 3.16 and press Filter
   
2. download the relevant Release files, i.e. a zip bada_316_80ddb12010d1cfc55fc7.zip
3. download the monthly update of interest, for example the Monthly update 2024-10 results in the zip bada_316_update_202410_ba71053b4a2f1ba034b8.zip
4. extract the zips, say in /home/users/typ/bada/4.3_2024-10 (note that the monthly update will overwrite the original SYNONYM.NEW of the release with an updated version)
5. update the bada_dir value in your pyBADA config file with the relevant path, i.e. /home/users/typ/bada/4.3_2024-10

---

Note
I would suggest some defaults in a dedicated config file (and document is in the Getting started or somewhere prominent), similarly to what done in traffic also here, something like

[bada]
# default to ~/Documents/bada/ or C:\Users\<userid>\bada
bada_path = /home/spi/Documents/bada/3.16_2024-10

Then on Linux/MacOS/...

import pyBADA
pyBADA.config_file
PosixPath('/home/spi/.config/pyBADA/pyBADA.conf')

and on MS Windows:

import pyBADA
pyBADA.config_file
PosixPath('C:\Users\AppData\Local\pyBADA/\pyBADA\pyBADA.conf')

---

First use

A very short example, less 10 lines of code, that uses the defaults (i.e. the Parser-ing is done on the configured installation, behind the scenes) just to plot "CAS as a function of distance"...