mitre-public/open-aria

An open-source edition of the Aviation Risk Identification and Assessment (ARIA)

Welcome to OpenARIA

This repository contains an open-source edition of the Aviation Risk Identification and Assessment (ARIA) software program developed by MITRE on behalf of the Federal Aviation Administration's (FAA) Safety and Technical Training (AJI) Service Unit.

OpenARIA's Goal

Our goal is to build a community focused on improving aviation safety & efficiency by extracting value from aircraft location data.

How OpenARIA can achieve this Goal

1. Provide a publicly available solution for detecting aviation risks within aircraft location data.

   • This tangible working solution can be critiqued by the community and improved as necessary.

2. Provide a publicly available solution for detecting and then aggregating aviation risks for bulk analysis.

   • Someone operating OpenARIA for a day will have one day's worth of output
   • Someone operating OpenARIA for a year will have a year's worth of output.
   • We must facilitate capturing and utilizing large amounts of output data.

3. Provide a publicly available solution for archiving and replaying aircraft location data

   • E.g., when OpenARIA detects an event, we will want to be able to replay the event to understand what happened.

4. Provide solutions that work with near-real time data streams as well as archival data.

---

Getting Started

• Learn about important ongoing work here and here
• Learn about the supported data formats here
  • Important Caveat: The initial code commit includes a dependency that is not available in the open source domain.
  • We are working to remove this blocker by:
    1. Proposing this data format (which will replace the legacy format)
    2. Adding support for this new data format
    3. Refactoring the code so the closed-source dependency is no longer used or required.
    4. Building the project using only GitHub Actions and publicly available dependencies
  • You can view the progress of this work by browsing the branches of the project.
• To begin detecting aviation events see here
• To begin archiving and replaying aircraft location data see here
• To begin detecting and then aggregating aviation data see here_

Building from Source

1. First clone the project: git clone git@github.com:mitre-public/open-aria.git
2. Navigate to project directory cd {PATH_TO_REPOSITORY}/open-aria
3. Run: ./gradlew shadowJar
   • This command launches a build plugin that collects all compiled code and dependencies into a single jar (aka uber jar, shadow jar, or fat jar)
4. Find the uber jar in:
   • {PATH_TO_REPOSITORY}/open-aria/open-aria-deploy/libs/build
   • The uber jar will have a name like: open-aria-0.1.0-SNAPSHOT-uber.jar

Downloading Pre-Built Artifact

There are 2 places to simply download a pre-built artifact

1. Download a full release from here
   • Coming soon (ETA = June 1st)
2. Download the artifact produced during a recent execution of the CI/CD system.
   • Click here to see the list of recent builds
   • Click on any build from the last 90 days (GitHub stores build artifacts for 90-days)
   • Download the Artifact named: Deployable-Uber-Jar

• TODO: Publish full releases to Maven Central.

---

Documentation

• High-level source code summary

• About ARIA's Airborne Event Data

  • An example of this JSON output data is here
  • A PDF describing the output data is here

• Architectural Decision Records (ADRs)

  • Supporting New Data Formats
  • Critique of Point and Track interfaces
  • Why YAML configs are preferable to Properties
  • How to compute an event's uniqueId

---

Using and Contributing

First of all, Welcome to the community!

Contributing as a User

• Please submit feedback.
• Do you have a technical question? If so, please ask. We are here to help. Your question could lead to improvements. User questions lead to improved documentation, understanding defects, and eventually code improvements the reach everyone in the community.
• Do you have a feature request? If so, please ask. We'll see what we can do given the development time we have available.

Contributing as a Developer

• We will use GitHub's Issue tracking features when the project launches.
• Anyone interested in making technical contributions is welcomed to communicate with the dev team on GitHub. Feel free to submit issues, fix issues, and submit PRs.
• We may write a "contributing guidelines" document in the future should the need arise. But for now, our focus will be on making high-quality, high-value improvements to the code (not policy documents).

Contributing as a Data Provider

• OpenARIA is extremely interested in collecting shareable aircraft position datasets. Publicly available datasets can become the benchmarks dataset by which OpenARIA algorithms are measured and optimized. Read more here about the fundamental project need.

---

Near-Term Project RoadMap

Version History & Release Notes

See here

MITRE Public Release

• Content approved for public release via The MITRE Corporation's "Public Release System" (PRS)
• Reference: Public Release Case Number: 23-3623

Legal Statement

• Copyright: The contents of this project is copyright The MITRE Corporation. See details here .
• Open Source License: This project is released under the Apache License Version 2.0. See details here.