# eklavyamirani/nand2tetris architecture

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

- Interactive diagram: https://gitdiagram.com/eklavyamirani/nand2tetris
- Repository: https://github.com/eklavyamirani/nand2tetris

## Overview

##### Main Components

A. Hardware Layer (Bottom-Up Approach)
- Basic Logic Gates (Project 01)
- ALU and Arithmetic Chips (Project 02)
- Sequential Logic (Project 03)
- Machine Language (Project 04)
- Computer Architecture (Project 05)

B. Software Layer
- Assembler (Project 06)
- VM Translator (Projects 07-08)
- Compiler (Projects 10-11)
- Operating System (Project 12)

C. Simulation Tools
- Hardware Simulator
- CPU Emulator
- VM Emulator
- Compiler
- Assembler

**[Tools Layer]**
**┌─────────────────────────────────────────────┐**
- Hardware    CPU       VM        Jack        │
- Simulator   Emulator  Emulator  Compiler    │
- ┘

**[Software Layer]**
**┌─────────────────────────────────────────────┐**
- Operating System (OS)                       │
- ┤
- Compiler                                    │
- ┤
- VM Translator                               │
- ┤
- Assembler                                   │
- ┘

**[Hardware Layer]**
**┌─────────────────────────────────────────────┐**
- Computer Architecture (CPU/Memory)          │
- ┤
- Machine Language                            │
- ┤
- Sequential Logic                            │
- ┤
- ALU & Arithmetic                            │
- ┤
- Basic Logic Gates                           │
- ┘

##### Additional Details

Sub-components for each major section:

A. Hardware Layer Details:
- Logic Gates: AND, OR, NOT, etc.
- Memory components: RAM, ROM
- CPU components: ALU, Registers
- Bus structure and data paths

B. Software Layer Details:
- OS APIs (Math, Memory, Screen, etc.)
- Compilation stages
- VM translation process
- Assembly process

##### Testing Flow

- .hdl files to Hardware Simulator
- .asm files to CPU Emulator
- .vm files to VM Emulator
- .jack files to Compiler

##### Implementation Notes

- Use standardized symbols for components:
- Rectangles: Processing units

- File extensions (.hdl, .asm, .vm, .jack)
- Testing file relationships (.tst, .cmp)
- Tool purposes and interactions

##### Docker Integration

A separate section showing how the Docker container encapsulates:
- Simulation tools
- Project files
- Testing environment

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef tools fill:#f9d79b,stroke:#e67e22
    classDef software fill:#a9dfbf,stroke:#27ae60
    classDef hardware fill:#aed6f1,stroke:#2980b9
    classDef docker fill:#d5d8dc,stroke:#566573

    %% Docker Container
    subgraph DC["Docker Environment"]
        %% Tools Layer
        subgraph TL["Tools Layer"]
            HS["Hardware Simulator"]:::tools
            CE["CPU Emulator"]:::tools
            VE["VM Emulator"]:::tools
            JC["Jack Compiler"]:::tools
            AS["Assembler"]:::tools
            BC["Built-in Chips"]:::tools
        end

        %% Software Layer
        subgraph SL["Software Layer"]
            OS["Operating System"]:::software
            CP["Compiler"]:::software
            VM["VM Translator"]:::software
            AB["Assembler"]:::software
        end

        %% Hardware Layer
        subgraph HL["Hardware Layer"]
            CA["Computer Architecture<br>CPU/Memory"]:::hardware
            ML["Machine Language"]:::hardware
            SL1["Sequential Logic"]:::hardware
            AA["ALU & Arithmetic"]:::hardware
            BL["Basic Logic Gates"]:::hardware
        end
    end

    %% Relationships
    BL --> AA
    AA --> SL1
    SL1 --> ML
    ML --> CA
    CA --> AB
    AB --> VM
    VM --> CP
    CP --> OS

    %% Testing Relationships
    HS -.-> BL
    HS -.-> AA
    HS -.-> SL1
    HS -.-> CA
    CE -.-> ML
    VE -.-> VM
    JC -.-> CP
    AS -.-> AB

    %% Click Events
    click BL "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/01"
    click AA "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/02"
    click SL1 "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/03"
    click ML "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/04"
    click CA "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/05"
    click AB "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/06"
    click VM "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/07"
    click CP "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/10"
    click OS "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/projects/12"
    click HS "https://github.com/eklavyamirani/nand2tetris/blob/master/nand2tetris/tools/HardwareSimulator.sh"
    click CE "https://github.com/eklavyamirani/nand2tetris/blob/master/nand2tetris/tools/CPUEmulator.sh"
    click VE "https://github.com/eklavyamirani/nand2tetris/blob/master/nand2tetris/tools/VMEmulator.sh"
    click JC "https://github.com/eklavyamirani/nand2tetris/blob/master/nand2tetris/tools/JackCompiler.sh"
    click AS "https://github.com/eklavyamirani/nand2tetris/blob/master/nand2tetris/tools/Assembler.sh"
    click BC "https://github.com/eklavyamirani/nand2tetris/tree/master/nand2tetris/tools/builtInChips"
```
