# alex870521/aeroviz architecture

> Architecture diagram of the GitHub repository alex870521/aeroviz, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/alex870521/aeroviz
- Repository: https://github.com/alex870521/aeroviz

## Overview

##### Main Components Identification
The system should be divided into three main components based on the core functionalities:

a. RawDataReader Module
- Handles raw data input from various aerosol instruments
- Includes quality control and data preprocessing
- Located in AeroViz/rawDataReader/

b. DataProcess Module
- Processes scientific calculations and analysis
- Contains multiple specialized submodules
- Located in AeroViz/dataProcess/

c. Plot Module
- Manages all visualization capabilities
- Contains various plotting templates and utilities
- Located in AeroViz/plot/

##### Component Relationships

**RawDataReader → DataProcess → plot**

##### Detailed Component Breakdown

For RawDataReader:
- Supported instruments (SMPS, APS, NEPH, etc.)
- QC pipeline
- Config management

For DataProcess:
- Separate into main processing categories:
- Chemistry
- Optical
- SizeDistr
- VOC
- Data flow between these components

For Plot:
- By plot types:
- Basic plots (scatter, bar, pie)
- Specialized plots (meteorology, optical)
- Templates
- Time series

##### Important Elements

- File format specifications at I/O points
- External tool dependencies
- Configuration files and their relationships
- Quality control checkpoints
- Data transformation pipelines

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        API[AeroViz API]
    end

    subgraph "Core Components"
        RDR[RawDataReader]
        DP[DataProcess]
        PLT[Plot]

        subgraph "RawDataReader Components"
            IS["Instrument Support"]:::script
            QC["Quality Control"]:::core
            CFG["Configuration"]:::config
        end

        subgraph "DataProcess Components"
            CHEM["Chemistry"]:::process
            OPT["Optical"]:::process
            SIZE["SizeDistr"]:::process
            VOC["VOC"]:::process
        end

        subgraph "Plot Components"
            BP["Basic Plots"]:::plot
            MP["Meteorology"]:::plot
            OP["Optical Plots"]:::plot
            TP["Templates"]:::plot
            TS["Time Series"]:::plot
            PU["Plot Utils"]:::plot
        end
    end

    subgraph "Data & Dependencies"
        DD["Default Data"]:::data
        VSD["VOC Support Data"]:::data
        ISR["ISRPIA Tool"]:::external
        ISRC["ISRPIA Config"]:::external
    end

    %% Relationships
    API --> RDR
    API --> DP
    API --> PLT

    RDR --> IS
    RDR --> QC
    RDR --> CFG

    DP --> CHEM
    DP --> OPT
    DP --> SIZE
    DP --> VOC

    PLT --> BP
    PLT --> MP
    PLT --> OP
    PLT --> TP
    PLT --> TS
    PLT --> PU

    CHEM --> ISR
    CHEM --> ISRC
    VOC --> VSD
    RDR --> DD

    %% Click Events
    click RDR "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/rawDataReader/"
    click IS "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/rawDataReader/script/"
    click QC "https://github.com/Alex870521/AeroViz/blob/main/AeroViz/rawDataReader/core/qc.py"
    click CFG "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/rawDataReader/config/"
    click DP "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/dataProcess/"
    click CHEM "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/dataProcess/Chemistry/"
    click OPT "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/dataProcess/Optical/"
    click SIZE "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/dataProcess/SizeDistr/"
    click VOC "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/dataProcess/VOC/"
    click PLT "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/plot/"
    click MP "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/plot/meteorology/"
    click OP "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/plot/optical/"
    click TP "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/plot/templates/"
    click TS "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/plot/timeseries/"
    click PU "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/plot/utils/"
    click ISR "https://github.com/Alex870521/AeroViz/blob/main/AeroViz/dataProcess/Chemistry/isrpia2.exe"
    click ISRC "https://github.com/Alex870521/AeroViz/blob/main/AeroViz/dataProcess/Chemistry/isrpia.cnf"
    click DD "https://github.com/Alex870521/AeroViz/tree/main/AeroViz/data/"
    click VSD "https://github.com/Alex870521/AeroViz/blob/main/AeroViz/dataProcess/VOC/support_voc.json"

    %% Styling
    classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px
    classDef script fill:#b8d4ff,stroke:#333
    classDef core fill:#ffb8b8,stroke:#333
    classDef config fill:#b8ffb8,stroke:#333
    classDef process fill:#d4b8ff,stroke:#333
    classDef plot fill:#ffdb99,stroke:#333
    classDef data fill:#e6e6e6,stroke:#333
    classDef external fill:#c2c2c2,stroke:#333

    %% Legend
    subgraph Legend
        L1[Script]:::script
        L2[Core]:::core
        L3[Config]:::config
        L4[Process]:::process
        L5[Plot]:::plot
        L6[Data]:::data
        L7[External]:::external
    end
```
