README.md

Mockingbird - Simulator

Python DataFrame-based ATC simulator.

Table of Contents

• Mockingbird - Simulator
  • Table of Contents
  • Requirements
  • Quickstart
  • Testing

Requirements

• Python
• Poetry

Quickstart

Clone the repository and cd into it:

git clone https://github.com/digiLab-ai/mockingbird-simulator.git
cd simulator

Copy the .env.example file to .env and fill out any missing values:

cp .env.example .env
open .env

Install the dependencies:

poetry install

Run the simulator:

poetry run python examples/run.py

Run from the top-level of the repository.

Testing

Run the test suite with pytest:

poetry run pytest