# ornl/intersect-architecture architecture

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

- Interactive diagram: https://gitdiagram.com/ornl/intersect-architecture
- Repository: https://github.com/ornl/intersect-architecture

## Overview

##### Project type and purpose
- This is the “INTERSECT Architecture Documentation” project—a documentation repository (Sphinx + RST) that describes a system-of-systems and microservice architecture for connecting scientific instruments, robot-controlled labs, and computing/data resources (edge, cloud, HPC).

##### File structure
- Top-level files:
- conf.py, Makefile, requirements.txt, Dockerfile, .readthedocs.yaml → standard Sphinx docs config and build scripts.
- README.md → overview of project purpose and usage.
- Key directories (each corresponds to a major doc section):
- examples/ → sample patterns (AAM).
- iri/ → design patterns and best practices for the Interconnected Resource Interface.
- ms/ → microservice classification, infrastructure, orchestration, deployment patterns.
- pat/ → science use-case design patterns (architectural, strategic).
- sos/ → system-of-systems (“SoS”) logical, physical, operational, data models, user interfaces.

##### README for additional insights
- The architecture comprises three pillars:
a. Science use-case design patterns (in pat/)
b. System-of-systems architecture (in sos/)
c. Microservice architecture (in ms/)
- It references edge/cloud/HPC, autonomous experiments, AI-driven workflows.

##### Detail
- Interaction with protocol or pattern (e.g., “HTTP/REST”, “gRPC”, “publish/subscribe”).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Edge Layer
    subgraph "Edge Layer"
        Inst["Scientific Instruments<br/>(Edge)"]:::external
        Ingest["Edge Gateway / Data Ingest Service"]:::microservice
    end

    %% Transport Layer
    MessageBus["Message Bus<br/>(Kafka/RabbitMQ)"]:::microservice

    %% Cloud/HPC Layer
    subgraph "Cloud/HPC Layer"
        APIGW["API Gateway / Service Mesh"]:::microservice
        ORM["Workflow Orchestrator"]:::microservice
        MSCluster["Microservice Cluster<br/>(compute-allocation,<br/>data-catalog,<br/>monitoring)"]:::microservice
        DataStore["Object Storage"]:::datastore
        MetaCat["Metadata Catalog<br/>(SQL/NoSQL)"]:::datastore
        HPC["HPC Resources"]:::external
        AI["AI/ML Engines"]:::external
    end

    %% User & External
    subgraph "User & External"
        UI["User Portal / Dashboards"]:::external
        IDMgmt["Identity Management"]:::external
    end

    %% Documentation Pillars
    subgraph "Documentation Pillars"
        Pat["Science Use-Case Design Patterns"]:::doc
        Sos["System-of-Systems Architecture"]:::doc
        MsDoc["Microservice Architecture"]:::doc
        Iri["Interconnected Resource Interface"]:::doc
        ExAAM["Example Architecture Models (AAM)"]:::doc
        Conf["Sphinx & Build Config"]:::doc
    end

    %% Connections
    Inst -->|HTTP/gRPC| Ingest
    Ingest -->|"publish/subscribe"| MessageBus
    MessageBus -->|subscribe| MSCluster
    MSCluster -->|store objects| DataStore
    MSCluster -->|update metadata| MetaCat
    ORM -->|invoke workflows| MSCluster
    ORM -->|coordinate compute| HPC
    MSCluster -->|"events/results"| MessageBus
    APIGW -->|routes requests| MSCluster
    UI -->|HTTP/REST| APIGW
    IDMgmt -->|auth tokens| APIGW
    MSCluster -->|calls| AI

    %% Click Events
    click Pat "https://github.com/ornl/intersect-architecture/blob/main/pat/index.rst"
    click Sos "https://github.com/ornl/intersect-architecture/blob/main/sos/index.rst"
    click MsDoc "https://github.com/ornl/intersect-architecture/blob/main/ms/index.rst"
    click Iri "https://github.com/ornl/intersect-architecture/blob/main/iri/index.rst"
    click ExAAM "https://github.com/ornl/intersect-architecture/blob/main/examples/aam/index.rst"
    click Conf "https://github.com/ornl/intersect-architecture/blob/main/conf.py"

    %% Styles
    classDef microservice fill:#cce5ff,stroke:#004085,color:#004085,stroke-width:1px
    classDef external fill:#d4edda,stroke:#155724,color:#155724,stroke-width:1px
    classDef datastore fill:#fff3cd,stroke:#856404,color:#856404,stroke-width:1px
    classDef doc fill:#e2e3e5,stroke:#6c757d,color:#6c757d,stroke-width:1px,stroke-dasharray: 5 5
```
