# bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices architecture

> Architecture diagram of the GitHub repository bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices
- Repository: https://github.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices

## Overview

##### Project type and purpose
- This is a standalone research/code‐analysis tool (not a web or mobile app) for “Singular Value Cleaning of Lagged Covariance Matrices” using the Rotationally Invariant Estimator (RIE).

##### File structure
- Top‐level scripts:
- RIE_visualisation.py – orchestrates data loading, RIE computation, and plotting.
- phi_AR.py – computes and validates φ‐distribution for AR(1) models.
- base_functions.py – core routines (matrix assembly, covariance, RIE algorithm).
- Data & output directory:
- data_and_figures/ – stores input data subsets (e.g. “AR(1)” and “RG”) and generated figures.
- Config & dependencies:
- requirements.txt – external libraries (NumPy, Matplotlib, SciPy, Pandas, Scikit‐Learn, Statsmodels).
- README.md – usage instructions and domain notes.

##### README for additional insights
- Usage patterns: both scripts are invoked from the command line.
- Configurable visualization parameters (figure size, save/display flags, models).
- Domain note: exponent discrepancy (–1/12 vs –1/6) documented for clarity.

##### Elements
– Data Store, Core Library, RIE Script, φ‐Script, External Libraries, Output Store
– Data → Core → Script → Output
– Scripts also invoke Core directly
– Blue for code modules, green for data stores, orange for external libs, purple for outputs
– “import”, “read data”, “compute RIE”, “plot/save figures”, “validate φ”

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Data Layer
    subgraph "Data Layer"
        DataStore["data_and_figures/"]:::data
    end

    %% Core Library
    subgraph "Core Library"
        Core["base_functions.py"]:::code
    end

    %% Scripts Layer
    subgraph "Orchestration Scripts"
        Script1["RIE_visualisation.py"]:::code
        Script2["phi_AR.py"]:::code
    end

    %% External Dependencies
    subgraph "External Dependencies"
        Dependencies["requirements.txt"]:::external
    end

    %% Documentation
    subgraph "Documentation & Usage"
        Readme["README.md"]:::docs
    end

    %% Relationships
    DataStore -->|"read data"| Script1
    Script1 -->|"import" | Core
    Core -->|"compute RIE"| Script1
    Script1 -->|"plot/save figures"| DataStore

    Script2 -->|"import"| Core
    Core -->|"compute φ"| Script2
    Script2 -->|"log comparison"| DataStore

    Script1 -.->|"requires"| Dependencies
    Script2 -.->|"requires"| Dependencies
    Core     -.->|"requires"| Dependencies

    Script1 -->|"usage info"| Readme
    Script2 -->|"usage info"| Readme

    %% Domain Note
    Note["Exponent discrepancy: –1/12 vs –1/6"]:::docs
    Note -.-> Core

    %% Click Events
    click DataStore "https://github.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices/tree/main/data_and_figures/"
    click Core "https://github.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices/blob/main/base_functions.py"
    click Script1 "https://github.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices/blob/main/RIE_visualisation.py"
    click Script2 "https://github.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices/blob/main/phi_AR.py"
    click Dependencies "https://github.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices/blob/main/requirements.txt"
    click Readme "https://github.com/bryan-cheong/rie-singular-value-cleaning-of-lagged-covariance-matrices/blob/main/README.md"

    %% Styles
    classDef data fill:#e0f7e0,stroke:#0a0,color:#000;
    classDef code fill:#e0f0ff,stroke:#00f,color:#000;
    classDef external fill:#fff0e0,stroke:#f70,color:#000;
    classDef docs fill:#f0e0ff,stroke:#f0f,color:#000;
```
