example_scripts/README.md

# Example Scripts — Automatum Data Highway Area Pools (Multi-Drone)

These scripts demonstrate how to work with the Automatum drone traffic data using the `openautomatumdronedata` Python library.

## Prerequisites

```bash
pip install openautomatumdronedata setuptools numpy matplotlib
```

## Scripts

| Script | Description |
|--------|-------------|
| `01_lane_changes.py` | Analyzes lane change frequency per vehicle and shows the top 10 (lanes are estimated from the lateral position, because this release does not contain `lane_id_vec`) |
| `02_heatmap_density.py` | Creates a traffic density heatmap from all position data |
| `03_high_acceleration.py` | Detects vehicles exceeding an acceleration threshold |
| `04_pooling_gain.py` | Compares a pool with its two single-drone recordings: road extent, track length distribution, share of tracks > 1 km |

## Usage

All scripts take the path to a recording or pool folder as their first argument.
With only `Sample_Data/` downloaded:

```bash
python 01_lane_changes.py ../Sample_Data/Pool-Highway-A9-OffenbauRastanlage_c025-c02598c7-fa60-4302-8cee-12a05f4e0db6
python 02_heatmap_density.py ../Sample_Data/Pool-Highway-A9-OffenbauRastanlage_c025-c02598c7-fa60-4302-8cee-12a05f4e0db6
python 03_high_acceleration.py ../Sample_Data/Pool-Highway-A9-OffenbauRastanlage_c025-c02598c7-fa60-4302-8cee-12a05f4e0db6 3.0
python 04_pooling_gain.py ../Sample_Data/Pool-Highway-A9-OffenbauRastanlage_c025-c02598c7-fa60-4302-8cee-12a05f4e0db6
```

After extracting `automatum_data_highway_area_pools.zip` into `../automatum_data_highway_area_pools/`:

```bash
python 01_lane_changes.py ../automatum_data_highway_area_pools/Highway-A6-SchwabachWest_01_9b40-9b402ea6-ddb2-42f0-afb2-ae40876adeb4
python 02_heatmap_density.py ../automatum_data_highway_area_pools/Pool-Highway-A9-LentingSolarpark_4d29-4d29e1dc-1237-4777-9a49-0189aea0b68b
python 03_high_acceleration.py ../automatum_data_highway_area_pools/Highway-A9-OffenbauRastanlage_02_4d76-4d76cd4f-9594-40ea-8bfb-18c83a28eca0 3.0
# finds the two single-drone folders next to the pool automatically and writes a histogram
python 04_pooling_gain.py ../automatum_data_highway_area_pools/Pool-Highway-A6-SchwabachWest_b3c3-b3c33b28-c26b-44b7-a9ca-26cbfd9f02cc --plot pooling_gain.png
```

## Learn More

- [Full Documentation](https://openautomatumdronedata.readthedocs.io)
- [Automatum Data Website](https://automatum-data.com)