mirror of
https://github.com/PlaneQuery/OpenAirframes.git
synced 2026-09-14 01:48:55 +02:00
Ashley Childress
766b575ff8
Self-review of the two preceding commits. - the release body hardcoded one FAA basename while files: uploads every source by glob, so each release attached an asset it did not list; basenames are now derived the same way - allow_bootstrap was a standing matrix key on tc that nothing forced anyone to remove, so an outage longer than the release walk-back would have rebuilt from one day with a green run; it is now a workflow_dispatch input naming the one source permitted to bootstrap - the per-source glob excluded prefixes by substring while build_registry.py matches the source token exactly, so a future source named registry_* would have been dropped here and kept there; both now anchor on the same filename shape - README lists the Transport Canada asset, which the previous commit began publishing Generated-by: Claude Opus 5 <noreply@anthropic.com>
80 lines
3.6 KiB
Markdown
80 lines
3.6 KiB
Markdown
# OpenAirframes.org
|
||
|
||
OpenAirframes.org is an open-source, community-driven airframes database.
|
||
|
||
The data includes:
|
||
- Registration information from Civil Aviation Authorities (FAA)
|
||
- Airline data (e.g., Air France)
|
||
- Community contributions such as ownership details, military aircraft info, photos, and more
|
||
|
||
---
|
||
|
||
## For Users
|
||
|
||
A daily release is created at **06:00 UTC** and includes:
|
||
|
||
- **openairframes_community.csv**
|
||
All community submissions
|
||
|
||
- **openairframes_adsb.csv**
|
||
Airframes dataset derived from ADSB.lol network data. For each UTC day, a row is created for every icao observed in that day’s ADS-B messages, using registration data from [tar1090-db](https://github.com/wiedehopf/tar1090-db) (ADSBExchange & Mictronics).
|
||
Example Usage:
|
||
```python
|
||
import pandas as pd
|
||
url = "https://github.com/PlaneQuery/OpenAirframes/releases/download/openairframes-2026-03-18-main/openairframes_adsb_2024-01-01_2026-03-17.csv.gz" # 1GB
|
||
df = pd.read_csv(url)
|
||
df
|
||
```
|
||
|
||
- **openairframes_registry.csv**
|
||
Every national registry in one table, one row per registration record, with a `source`
|
||
column naming the registry it came from. Currently the FAA (United States) and Transport
|
||
Canada. Identifier columns (`transponder_code_hex`, `registration_number`,
|
||
`openairframes_id`) lead the table and are populated for every source.
|
||
|
||
- **openairframes_faa.csv**
|
||
All [FAA registration data](https://www.faa.gov/licenses_certificates/aircraft_certification/aircraft_registry/releasable_aircraft_download) from 2023-08-16 to present (~275 MB).
|
||
Superseded by `openairframes_registry.csv`; still published so existing consumers keep working.
|
||
|
||
- **openairframes_tc.csv**
|
||
The [Transport Canada Civil Aircraft Register](https://wwwapps.tc.gc.ca/saf-sec-sur/2/ccarcs-riacc/RchSimp.aspx),
|
||
~35k aircraft with full ICAO 24-bit hex coverage. Also folded into
|
||
`openairframes_registry.csv`; published separately for the same reason as the FAA CSV.
|
||
|
||
- **ReleasableAircraft_{date}.zip**
|
||
A daily snapshot of the FAA database, which updates at **05:30 UTC**
|
||
|
||
- **basic-ac-db.json.gz**
|
||
[ADS-B Exchange](https://www.adsbexchange.com/) basic aircraft database, republished unmodified.
|
||
|
||
- **mictronics-db.zip**
|
||
[Mictronics](https://www.mictronics.de/aircraft-database/) aircraft database, republished
|
||
unmodified. Best effort — the release ships without it when the source is unavailable.
|
||
|
||
Redistribution terms for the underlying sources travel with the release in **NOTICE**. Some
|
||
registries permit redistribution only on condition that specific notices reach you with the data.
|
||
|
||
---
|
||
|
||
## For Contributors
|
||
|
||
Submit data via a [GitHub Issue](https://github.com/PlaneQuery/OpenAirframes/issues/new?template=community_submission.yaml) with your preferred attribution. Once approved, it will appear in the daily release. A leaderboard will be available in the future.
|
||
All data is valuable. Examples include:
|
||
- Celebrity ownership (with citations)
|
||
- Photos
|
||
- Internet capability
|
||
- Military aircraft information
|
||
- Unique facts (e.g., an airframe that crashed, performs aerobatics, etc.)
|
||
|
||
Please try to follow the submission formatting guidelines. If you are struggling with them, that is fine—submit your data anyway and it will be formatted for you.
|
||
|
||
---
|
||
|
||
## For Developers
|
||
All code, compute (GitHub Actions), and storage (releases) are in this GitHub repository Improvements are welcome. Potential features include:
|
||
- Web UI for data
|
||
- Web UI for contributors
|
||
- Additional export formats in the daily release
|
||
- Data fusion from multiple sources in the daily release
|
||
- Automated airframe data connectors, including (but not limited to) civil aviation authorities and airline APIs
|