# manuvanegas/spatialrustmodel architecture

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

- Interactive diagram: https://gitdiagram.com/manuvanegas/spatialrustmodel
- Repository: https://github.com/manuvanegas/spatialrustmodel

## Overview

##### Project type and purpose
- This is an open-source, scientific agent-based simulation tool written in Julia, called SpatialRust.
- Its purpose is to simulate coffee leaf rust epidemics in agroforestry systems by integrating plant growth, shade trees, and disease spread.

##### File structure
- Top level:
- `scripts/`: installer and sample run launcher.
- `src/`: core Julia modules.
- `Project.toml` & `Manifest.toml`: package and dependency definitions.
- Inside `src/`:
- `SpatialRust.jl`: main entry point and CLI interface.
- `QuickRuns.jl` & `QuickMetrics.jl`: convenience wrappers for batch runs and metrics extraction.
- `ABM/`: all agent-based model components:
– `MainSetup.jl` & `CreateABM.jl`: initialize simulation parameters and domain.
– `FarmMap.jl`, `ShadeMap.jl`: spatial grid definitions for coffee plants and shade trees.
– `MainStep.jl`: orchestrates per-tick updates.
– `CoffeeSteps.jl`, `CGrowerSteps.jl`, `ShadeSteps.jl`, `RustGrowth.jl`, `RustDispersal.jl`: domain-specific update rules.

##### README for additional insights
- Confirms: spatially explicit, modular ABM, user-modifiable parameters.
- Workflow: install deps → run sample script → tweak parameters → inspect `results/`.

##### Detail
- Every module as a separate element to show the full structure.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Interface Scripts
    subgraph "User Interface (scripts)"
        direction TB
        UI_Install["install.jl"]:::scripts
        UI_Sample["samplerun.jl"]:::scripts
    end

    %% Core API
    subgraph "Core API"
        direction TB
        API_Main["SpatialRust.jl"]:::core
        API_Runs["QuickRuns.jl"]:::core
        API_Metrics["QuickMetrics.jl"]:::core
    end

    %% ABM Engine
    subgraph "ABM Engine (src/ABM)"
        direction TB
        ABM_Init1["MainSetup.jl"]:::abm
        ABM_Init2["CreateABM.jl"]:::abm
        ABM_Map1["FarmMap.jl"]:::abm
        ABM_Map2["ShadeMap.jl"]:::abm
        ABM_Loop["MainStep.jl"]:::abm
        ABM_Rule1["CoffeeSteps.jl"]:::abm
        ABM_Rule2["CGrowerSteps.jl"]:::abm
        ABM_Rule3["ShadeSteps.jl"]:::abm
        ABM_Rule4["RustGrowth.jl"]:::abm
        ABM_Rule5["RustDispersal.jl"]:::abm
    end

    %% Data Layer / Outputs
    subgraph "Data Layer / Outputs"
        direction TB
        Data_State["In-memory Model State"]:::data
        Data_Results["Results Writer (results/)"]:::data
    end

    %% Connections
    UI_Install -->|"invoke CLI"| API_Main
    UI_Sample -->|"invoke CLI"| API_Main
    API_Main -->|"run batch"| API_Runs
    API_Main -->|"run metrics"| API_Metrics

    API_Runs -->|"initialize()"| ABM_Init1
    API_Runs -->|"create_abm()"| ABM_Init2

    ABM_Init2 -->|"setup farms"| ABM_Map1
    ABM_Init2 -->|"setup shade"| ABM_Map2

    ABM_Map1 -->|"ready domain"| ABM_Loop
    ABM_Map2 -->|"ready domain"| ABM_Loop

    ABM_Loop -->|"step()"| ABM_Rule1
    ABM_Loop -->|"step()"| ABM_Rule2
    ABM_Loop -->|"step()"| ABM_Rule3
    ABM_Loop -->|"step()"| ABM_Rule4
    ABM_Loop -->|"step()"| ABM_Rule5
    ABM_Rule1 -->|"update state"| Data_State
    ABM_Rule2 -->|"update state"| Data_State
    ABM_Rule3 -->|"update state"| Data_State
    ABM_Rule4 -->|"update state"| Data_State
    ABM_Rule5 -->|"update state"| Data_State

    Data_State -->|"write files"| Data_Results
    API_Metrics -->|"compute_metrics()"| Data_State
    API_Metrics -->|"write summary"| Data_Results

    %% Click Events
    click UI_Install "https://github.com/manuvanegas/spatialrustmodel/blob/main/scripts/install.jl"
    click UI_Sample "https://github.com/manuvanegas/spatialrustmodel/blob/main/scripts/samplerun.jl"
    click API_Main "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/SpatialRust.jl"
    click API_Runs "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/QuickRuns.jl"
    click API_Metrics "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/QuickMetrics.jl"
    click ABM_Init1 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/MainSetup.jl"
    click ABM_Init2 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/CreateABM.jl"
    click ABM_Map1 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/FarmMap.jl"
    click ABM_Map2 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/ShadeMap.jl"
    click ABM_Loop "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/MainStep.jl"
    click ABM_Rule1 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/CoffeeSteps.jl"
    click ABM_Rule2 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/CGrowerSteps.jl"
    click ABM_Rule3 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/ShadeSteps.jl"
    click ABM_Rule4 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/RustGrowth.jl"
    click ABM_Rule5 "https://github.com/manuvanegas/spatialrustmodel/blob/main/src/ABM/RustDispersal.jl"

    %% Styles
    classDef scripts fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef core fill:#1E90FF,stroke:#333,stroke-width:1px,color:#fff
    classDef abm fill:#90EE90,stroke:#333,stroke-width:1px
    classDef data fill:#FFA500,stroke:#333,stroke-width:1px,color:#fff
```
