# keeganmjgreen/green_airliner architecture

> Architecture diagram of the GitHub repository keeganmjgreen/green_airliner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/keeganmjgreen/green_airliner
- Repository: https://github.com/keeganmjgreen/green_airliner

## Overview

##### Key Interactions

a. Data Flow
- Configuration → Simulation Core
- Simulation Core → Visualization System
- Modeling Components → Simulation Core
- Data Processing → Visualization

b. Component Dependencies
- Environment handling (environments/)
- Utility functions (utils/)
- Feasibility study integration

##### Technical Details

- Python/Conda environment dependencies
- VPython browser interface
- File I/O operations
- Command-line interface points

**[Configuration Layer]**
- ↓
**[Data Processing Layer] → [Simulation Core] ← [Modeling Layer]**
- ↓                        ↓
**[Visualization Layer] → [Output Generation]**

- Blue: Core simulation components
- Green: Data processing components
- Orange: Visualization components
- Purple: Configuration components
- Gray: Utility and support functions

Important Notes:
##### External dependencies (VPython, browser interface)
4. Entry points for different execution modes (simulation, visualization, feasibility study)

Remember to include notes about the scalability of the system, particularly regarding the handling of multiple UAVs and different flight paths, as this appears to be a key feature of the simulation.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and classes
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef config fill:#9b59b6,stroke:#8e44ad,color:white
    classDef model fill:#2ecc71,stroke:#27ae60,color:white
    classDef viz fill:#e67e22,stroke:#d35400,color:white
    classDef data fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef env fill:#1abc9c,stroke:#16a085,color:white
    classDef utils fill:#bdc3c7,stroke:#95a5a6,color:white

    %% Configuration Layer
    subgraph ConfigSystem
        Config["Configuration System"]
        SimConfig["Simulation Config YAML"]
        JsonSchema["JSON Schema"]
        SchemaGen["Schema Generator"]
    end
    
    %% Core Simulation
    subgraph SimCore
        Simulation["Simulation Core"]
        AirplaneSim["Airplanes Simulator"]
    end
    
    %% Modeling Layer
    subgraph ModelingSystem
        ModelObjects["Modeling Objects"]
        Specs["Specifications"]
        FeasStudy["Feasibility Study"]
        FeasObjects["Feasibility Objects"]
    end
    
    %% Data Processing
    subgraph DataProcessing
        WaypointsGen["Waypoints Generator"]
        CurvePoints["Curve Points Generator"]
        AirportData["Airport Locations"]
        MakeAirplanes["Airplane Generator"]
    end
    
    %% Visualization
    subgraph VisualizationSystem
        VizPaths["Path Visualization"]
        VizModels["3D Models"]
        AirportViz["Airport Visualizer"]
        VizEnv["Visualizer Environment"]
    end
    
    %% Support Systems
    subgraph Environment
        EnvBase["Environment Base"]
        AirplanesEnv["Airplanes Environment"]
    end
    
    Utils["Utility Functions"]

    %% Connections
    Config --> SimConfig
    Config --> JsonSchema
    Config --> SchemaGen
    
    SimConfig --> Simulation
    ModelObjects --> Simulation
    Specs --> Simulation
    FeasStudy --> Simulation
    
    WaypointsGen --> Simulation
    CurvePoints --> Simulation
    AirportData --> WaypointsGen
    MakeAirplanes --> Simulation
    
    Simulation --> VizPaths
    Simulation --> VizModels
    Simulation --> AirportViz
    
    EnvBase --> AirplanesEnv
    AirplanesEnv --> VizEnv
    
    Utils --> Simulation
    Utils --> DataProcessing
    Utils --> VisualizationSystem

    %% Click events
    click Simulation "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/simulation.py"
    click AirplaneSim "https://github.com/keeganmjgreen/green_airliner/blob/main/src/airplanes_simulator.py"
    click SimConfig "https://github.com/keeganmjgreen/green_airliner/blob/main/configs/jfk_to_lax/simulation_config.yml"
    click JsonSchema "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/simulation_config_json_schema.json"
    click SchemaGen "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/simulation_config_schema.py"
    click ModelObjects "https://github.com/keeganmjgreen/green_airliner/blob/main/src/modeling_objects.py"
    click Specs "https://github.com/keeganmjgreen/green_airliner/blob/main/src/specs.py"
    click FeasStudy "https://github.com/keeganmjgreen/green_airliner/blob/main/src/feasibility_study/feasibility_study.py"
    click FeasObjects "https://github.com/keeganmjgreen/green_airliner/blob/main/src/feasibility_study/modeling_objects.py"
    click VizPaths "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/viz_airplane_paths.py"
    click VizModels "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/viz_models.py"
    click AirportViz "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/viz_airport_locations.ipynb"
    click VizEnv "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/environments/airplanes_visualizer_environment.py"
    click WaypointsGen "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/airplane_waypoints_generation.py"
    click CurvePoints "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/planar_curve_points_generation.py"
    click AirportData "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/airport_locations.csv"
    click MakeAirplanes "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/make_airplanes.py"
    click EnvBase "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/environments/environment.py"
    click AirplanesEnv "https://github.com/keeganmjgreen/green_airliner/blob/main/src/three_d_sim/environments/airplanes_visualizer_environment.py"
    click Utils "https://github.com/keeganmjgreen/green_airliner/blob/main/src/utils/utils.py"

    %% Style Applications
    class Simulation,AirplaneSim core
    class Config,SimConfig,JsonSchema,SchemaGen config
    class ModelObjects,Specs,FeasStudy,FeasObjects model
    class VizPaths,VizModels,AirportViz,VizEnv viz
    class WaypointsGen,CurvePoints,AirportData,MakeAirplanes data
    class EnvBase,AirplanesEnv env
    class Utils utils
```
