# lalitnayyar/iimkmodule4assignment architecture

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

- Interactive diagram: https://gitdiagram.com/lalitnayyar/iimkmodule4assignment
- Repository: https://github.com/lalitnayyar/iimkmodule4assignment

## Overview

##### Main components
a. Data Sources
- Online Retail.xlsx (raw transactional data)
- cleaned_retail_data.csv (intermediate cleaned data)
b. Data Processing & Cleaning Layer
- `LalitNayyarIIMKMod4_analysis_fin.ipynb` (data profiling, cleaning functions)
- fixnotebookscripts/ (a library of Python scripts to auto-fix notebooks)
c. Analytics Notebooks (core analysis stages)
- Descriptive: `LalitNayyarIIMKMod4_descriptive_analysis_fin.ipynb`
- Diagnostic: `LalitNayyarIIMKMod4_behavior_diagnostic_analysis_fin.ipynb`
- Predictive: `LalitNayyarIIMKMod4_predictive_analysis_fin.ipynb`
- (plus transitionnotebooks/ historical versions)
d. Submission Generation Layer
- submissionpython/ (scripts that convert notebooks to HTML, apply templates & styling)
e. Environment & Configuration
- requirements.txt (Python dependencies)
- Jupyter execution environment (runtime)

##### Relationships & data flow
1. Raw data (Excel) → Data preprocessing notebook
2. Preprocessing → cleaned_retail_data.csv
3. cleaned_retail_data.csv → Descriptive, Diagnostic, Predictive notebooks
4. Each analysis notebook outputs figures, tables, and intermediate results
5. fixnotebookscripts/ can be invoked at any notebook stage to standardize formatting or fix metadata
6. submissionpython/ consumes final notebooks → produces HTML submissions (with themes, TOC, contrast, etc.)

##### Architectural patterns & design principles
- Pipeline architecture: sequential flow (Ingest → Clean → Analyze → Publish)
- Modularization: separation of concerns
- Cleaning code in one notebook + reusable Python scripts
- Analysis split by maturity stage
- Presentation code in dedicated scripts
- Extensibility: drop-in additional analysis notebooks or submission templates without disrupting core pipeline
- Reproducibility: versioned notebooks + requirements.txt + scripted conversion

##### Relevant technologies/frameworks
- Python ecosystem: pandas, numpy, matplotlib, seaborn, scikit-learn
- Jupyter Notebook / nbconvert
- Custom notebook fixer scripts (pure Python)
- HTML/CSS templates (via submissionpython scripts)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Data Layer
    subgraph "Data Layer"
        DataRaw["Online Retail.xlsx"]:::data
        DataClean["cleaned_retail_data.csv"]:::data
    end

    %% Processing & Cleaning Layer
    subgraph "Processing & Cleaning Layer"
        CleanNotebook["LalitNayyarIIMKMod4_analysis_fin.ipynb"]:::process
        FixScripts["fixnotebookscripts/"]:::process
    end

    %% Analysis Layer
    subgraph "Analysis Layer"
        Descriptive["LalitNayyarIIMKMod4_descriptive_analysis_fin.ipynb"]:::analysis
        Diagnostic["LalitNayyarIIMKMod4_behavior_diagnostic_analysis_fin.ipynb"]:::analysis
        Predictive["LalitNayyarIIMKMod4_predictive_analysis_fin.ipynb"]:::analysis
        Transition["transitionnotebooks/"]:::analysis
    end

    %% Delivery Layer
    subgraph "Delivery Layer"
        Submission["submissionpython/"]:::delivery
        HTML["HTML Reports"]:::delivery
    end

    %% Configuration & Environment
    subgraph "Configuration"
        Requirements["requirements.txt"]:::config
        Jupyter["Jupyter Environment\n(Python 3.x)"]:::config
    end

    %% Data Flow Connections
    DataRaw -->|"ingests raw data"| CleanNotebook
    CleanNotebook -->|"writes cleaned_retail_data.csv"| DataClean
    DataClean -->|"reads cleaned_retail_data.csv"| Descriptive
    DataClean -->|"reads cleaned_retail_data.csv"| Diagnostic
    DataClean -->|"reads cleaned_retail_data.csv"| Predictive

    %% Utility Invocations
    CleanNotebook -->|"invoke fixer"| FixScripts
    Descriptive -->|"invoke fixer"| FixScripts
    Diagnostic -->|"invoke fixer"| FixScripts
    Predictive -->|"invoke fixer"| FixScripts

    %% Analysis to Delivery
    Descriptive -->|"outputs analysis"| Submission
    Diagnostic -->|"outputs analysis"| Submission
    Predictive -->|"outputs analysis"| Submission

    Submission -->|"generates HTML files"| HTML

    %% Configuration Relationships
    Requirements -.-> CleanNotebook
    Requirements -.-> Descriptive
    Requirements -.-> Diagnostic
    Requirements -.-> Predictive
    Jupyter -.-> CleanNotebook
    Jupyter -.-> Descriptive
    Jupyter -.-> Diagnostic
    Jupyter -.-> Predictive

    %% Click Events
    click DataRaw "https://github.com/lalitnayyar/iimkmodule4assignment/blob/main/Online Retail.xlsx"
    click DataClean "https://github.com/lalitnayyar/iimkmodule4assignment/blob/main/cleaned_retail_data.csv"
    click CleanNotebook "https://github.com/lalitnayyar/iimkmodule4assignment/blob/main/LalitNayyarIIMKMod4_analysis_fin.ipynb"
    click FixScripts "https://github.com/lalitnayyar/iimkmodule4assignment/tree/main/fixnotebookscripts/"
    click Descriptive "https://github.com/lalitnayyar/iimkmodule4assignment/blob/main/LalitNayyarIIMKMod4_descriptive_analysis_fin.ipynb"
    click Diagnostic "https://github.com/lalitnayyar/iimkmodule4assignment/blob/main/LalitNayyarIIMKMod4_behavior_diagnostic_analysis_fin.ipynb"
    click Predictive "https://github.com/lalitnayyar/iimkmodule4assignment/blob/main/LalitNayyarIIMKMod4_predictive_analysis_fin.ipynb"
    click Transition "https://github.com/lalitnayyar/iimkmodule4assignment/tree/main/transitionnotebooks/"
    click Submission "https://github.com/lalitnayyar/iimkmodule4assignment/tree/main/submissionpython/"
    click Requirements "https://github.com/lalitnayyar/iimkmodule4assignment/blob/main/requirements.txt"

    %% Styles
    classDef data fill:#cce5ff,stroke:#1f77b4,color:#1f1f1f;
    classDef process fill:#d4edda,stroke:#28a745,color:#1f1f1f;
    classDef analysis fill:#fff3cd,stroke:#ffc107,color:#1f1f1f;
    classDef delivery fill:#d6d8f0,stroke:#6f42c1,color:#1f1f1f;
    classDef config fill:#f8f9fa,stroke:#6c757d,color:#1f1f1f;
```
