# varishtraheja/houdini-pipeline-dev architecture

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

- Interactive diagram: https://gitdiagram.com/varishtraheja/houdini-pipeline-dev
- Repository: https://github.com/varishtraheja/houdini-pipeline-dev

## Overview

##### Project type and purpose
- This is not a web app or microservice, but a set of Houdini Digital Assets (HDAs) and accompanying Python/VEX scripts that extend Houdini’s node-graph workflow.
- Purpose: automate backups, export geometry to JSON, check for duplicate RBD names, and filter asset files.

##### High-level components
- Houdini Application (host environment)
‑ Asset Manager & Node Graph
‑ Python Interpreter & VEX Engine
- HDAs (in HDA/*.hdanc)
‑ BackupTool
‑ Json_Exporter
‑ Asset_Filter
- Python Scripts (in Scripts/*.py)
‑ backup-tool.py
‑ jsonExporter.py
‑ RBD_Check.py
‑ Asset_Filter.py
- VEX Wrangle Nodes (embedded in HDAs or invoked at runtime)
- File System / Data Stores
‑ .py backup output
‑ JSON export files
‑ log files (optional)
- External Consumers
‑ Cross-platform apps that read the JSON geometry

##### Relationships & Data Flows
a. User → Houdini UI
- Installs HDAs
- Drops an HDA node into the network
- Clicks HDA buttons or parameters
b. HDA UI → Python Scripts
- Parameter callbacks trigger Scripts/*.py via the “hou” API
c. Python Scripts ↔ Node Graph
- Scripts enumerate selected nodes, query/modify parameters, create new nodes (e.g., file nodes)
d. Python/VEX → File System
- backup-tool.py writes a .py script snapshot to disk
- jsonExporter.py writes JSON files of geometry
e. VEX Wrangles → Node Attributes
- Asset_Filter VEX logic marks & groups points for inclusion/exclusion and sequence detection
f. External Consumer ← JSON Files

##### Architectural patterns & design principles
- Plugin/extension architecture: HDAs compile into .hdanc and hook into Houdini’s Asset Manager
- Event-driven callbacks: HDA buttons fire Python functions via `hou.ui`
- Separation of concerns:
- UI layer (HDA parameters)
- Logic layer (Python scripts & VEX code)
- Data layer (file system output)
- Proceduralism & dataflow: VEX attribute streams, split & merge groups

##### Technologies & frameworks
- Houdini HDAs (.hdanc files)
- Python API for Houdini (`hou` module)
- VEX (attribute wrangles inside Houdini)
- JSON (export format)
- Standard Python libs (os, re, json)

##### Elements
- Boundary marking “Inside Houdini” vs. external

## Diagram (Mermaid)

```mermaid
flowchart TD
    User["User"]:::ui

    subgraph "Houdini Host Environment"
        subgraph "Asset Manager (HDAs)"
            BTHDA["BackupTool HDA"]:::ui
            JEHDA["Json_Exporter HDA"]:::ui
            AFHDA["Asset_Filter HDA"]:::ui
            IconRBD["RBD Checker Icon"]:::ui
        end

        subgraph "Python Engine"
            BTpy["backup-tool.py"]:::logic
            JEpy["jsonExporter.py"]:::logic
            RBDpy["RBD_Check.py"]:::logic
            AFpy["Asset_Filter.py"]:::logic
        end

        subgraph "VEX Engine"
            VEXRBD["RBD_Check Wrangle"]:::logic
            VEXAF["Asset_Filter Wrangle"]:::logic
        end

        subgraph "Node Graph"
            NodeGraph["Procedural Network"]:::logic
        end
    end

    FileSystem(("File System")):::data
    External["External Consumer (JSON reader)"]:::ext

    %% User interactions
    User -->|"installs HDAs / drops nodes"| BTHDA
    User -->|"installs HDAs / drops nodes"| JEHDA
    User -->|"installs HDAs / drops nodes"| AFHDA

    %% HDA callbacks to Python
    BTHDA -->|"invokes"| BTpy
    JEHDA -->|"invokes"| JEpy
    AFHDA -->|"invokes"| AFpy
    AFHDA -->|"invokes"| RBDpy

    %% Python scripts to Node Graph
    BTpy -->|"modifies nodes"| NodeGraph
    JEpy -->|"modifies nodes"| NodeGraph
    RBDpy -->|"checks nodes"| NodeGraph
    AFpy -->|"filters assets"| NodeGraph

    %% VEX to Node Graph
    VEXRBD -->|"sets flags/colors"| NodeGraph
    VEXAF -->|"marks groups"| NodeGraph

    %% Python/VEX to File System
    BTpy -->|"writes .py snapshot"| FileSystem
    JEpy -->|"writes JSON files"| FileSystem
    RBDpy -->|"writes log flags"| FileSystem
    AFpy -->|"writes log files"| FileSystem
    VEXAF -->|"writes group data"| FileSystem

    %% File System to External
    FileSystem -->|"reads JSON"| External

    %% Click Events
    click BTHDA "https://github.com/varishtraheja/houdini-pipeline-dev/blob/main/HDA/object_Varisht.BackupTool.1.0.hdanc"
    click JEHDA "https://github.com/varishtraheja/houdini-pipeline-dev/blob/main/HDA/object_Varisht.json_exporter.1.0.hdanc"
    click AFHDA "https://github.com/varishtraheja/houdini-pipeline-dev/blob/main/HDA/sop_Varisht.Asset_Filter_copy.1.0.hdanc"
    click BTpy "https://github.com/varishtraheja/houdini-pipeline-dev/blob/main/Scripts/backup-tool.py"
    click JEpy "https://github.com/varishtraheja/houdini-pipeline-dev/blob/main/Scripts/jsonExporter.py"
    click RBDpy "https://github.com/varishtraheja/houdini-pipeline-dev/blob/main/Scripts/RBD_Check.py"
    click AFpy "https://github.com/varishtraheja/houdini-pipeline-dev/blob/main/Scripts/Asset_Filter.py"
    click IconRBD "https://github.com/varishtraheja/houdini-pipeline-dev/tree/main/images/rbd-checker"

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#000
    classDef logic fill:#90EE90,stroke:#000
    classDef data fill:#FFA500,stroke:#000
    classDef ext fill:#D3D3D3,stroke:#000
```
