# laat0003/ncgrt_introflopy architecture

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

- Interactive diagram: https://gitdiagram.com/laat0003/ncgrt_introflopy
- Repository: https://github.com/laat0003/ncgrt_introflopy

## Overview

This repository is a set of Jupyter workshops teaching groundwater modeling with FloPy, rather than a standalone application. The likely user workflow is to open workshop notebooks, work through model construction and GIS inputs, then run and inspect simulations. The README only identifies the workshop series; sampled helper code confirms simulation execution, head/budget extraction, grid refinement, and boundary-condition setup. Notebook-to-helper wiring and the content of unsampled workshops are not established by the available excerpts, so those links are marked unverified.

Main entry points: [`helpers.py`](https://github.com/laat0003/ncgrt_introflopy/blob/main/helpers.py) (Model helpers), [`Workshop_1.ipynb`](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_1.ipynb) (Workshop 1), [`Workshop_2.ipynb`](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_2.ipynb) (Workshop 2), [`Workshop_3.ipynb`](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_3.ipynb) (Workshop 3)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_learning["Workshop notebooks"]
  node_workshop1["Workshop 1<br/>[Workshop_1.ipynb]"]
  node_workshop2["Workshop 2<br/>[Workshop_2.ipynb]"]
  node_workshop3["Workshop 3<br/>[Workshop_3.ipynb]"]
  node_workshop4["Workshop 4<br/>[Workshop_4.ipynb]"]
  node_workshop5["Workshop 5<br/>[Workshop_5.ipynb]"]
  node_workshop6["Workshop 6<br/>[Workshop_6.ipynb]"]
  node_workshop7["Workshop 7<br/>[Workshop_7.ipynb]"]
  node_workshop8["Workshop 8<br/>[Workshop_8.ipynb]"]
end

subgraph group_modeling["Model construction"]
  node_helpers["Model helpers<br/>[helpers.py]"]
end

subgraph group_examples["Example data"]
  node_gisdata["GIS inputs"]
  node_modeldata["Model examples"]
  node_leapfrog["Leapfrog export"]
end

node_learner(("Learner"))
node_flopy["FloPy"]

node_learner -->|"opens"| node_workshop1
node_learner -->|"opens"| node_workshop2
node_learner -->|"opens"| node_workshop3
node_learner -->|"opens"| node_workshop4
node_learner -->|"opens"| node_workshop5
node_learner -->|"opens"| node_workshop6
node_learner -->|"opens"| node_workshop7
node_learner -->|"opens"| node_workshop8
node_workshop1 -.->|"may use"| node_helpers
node_workshop2 -.->|"may use"| node_helpers
node_workshop3 -.->|"may use"| node_helpers
node_workshop4 -.->|"may use"| node_helpers
node_workshop5 -.->|"may use"| node_helpers
node_workshop6 -.->|"may use"| node_helpers
node_workshop7 -.->|"may use"| node_helpers
node_workshop8 -.->|"may use"| node_helpers
node_helpers -->|"uses"| node_flopy

click node_workshop1 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_1.ipynb"
click node_workshop2 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_2.ipynb"
click node_workshop3 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_3.ipynb"
click node_workshop4 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_4.ipynb"
click node_workshop5 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_5.ipynb"
click node_workshop6 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_6.ipynb"
click node_workshop7 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_7.ipynb"
click node_workshop8 "https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_8.ipynb"
click node_helpers "https://github.com/laat0003/ncgrt_introflopy/blob/main/helpers.py"
click node_gisdata "https://github.com/laat0003/ncgrt_introflopy/tree/main/files/disv_shapefiles"
click node_modeldata "https://github.com/laat0003/ncgrt_introflopy/tree/main/files/zbudmod"
click node_leapfrog "https://github.com/laat0003/ncgrt_introflopy/tree/main/files/Leapfrog_Export"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_workshop1,node_workshop2,node_workshop3,node_workshop4,node_workshop5,node_workshop6,node_workshop7,node_workshop8 toneBlue
class node_helpers toneAmber
class node_gisdata,node_modeldata,node_leapfrog toneMint
class node_learner,node_flopy toneIndigo
```

## Components

### Workshop notebooks

- [Workshop 1](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_1.ipynb): `Workshop_1.ipynb`
- [Workshop 2](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_2.ipynb): `Workshop_2.ipynb`
- [Workshop 3](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_3.ipynb): `Workshop_3.ipynb`
- [Workshop 4](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_4.ipynb): `Workshop_4.ipynb`
- [Workshop 5](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_5.ipynb): `Workshop_5.ipynb`
- [Workshop 6](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_6.ipynb): `Workshop_6.ipynb`
- [Workshop 7](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_7.ipynb): `Workshop_7.ipynb`
- [Workshop 8](https://github.com/laat0003/ncgrt_introflopy/blob/main/Workshop_8.ipynb): `Workshop_8.ipynb`

### Model construction

- [Model helpers](https://github.com/laat0003/ncgrt_introflopy/blob/main/helpers.py): `helpers.py`

### Example data

- [GIS inputs](https://github.com/laat0003/ncgrt_introflopy/tree/main/files/disv_shapefiles): `files/disv_shapefiles`
- [Model examples](https://github.com/laat0003/ncgrt_introflopy/tree/main/files/zbudmod): `files/zbudmod`
- [Leapfrog export](https://github.com/laat0003/ncgrt_introflopy/tree/main/files/Leapfrog_Export): `files/Leapfrog_Export`

### Other components

- **Learner**
- **FloPy**

## Connections

- Learner → Workshop 1: opens (evidence: `README.md`)
- Learner → Workshop 2: opens (evidence: `README.md`)
- Learner → Workshop 3: opens (evidence: `README.md`)
- Learner → Workshop 4: opens (evidence: `README.md`)
- Learner → Workshop 5: opens (evidence: `README.md`)
- Learner → Workshop 6: opens (evidence: `README.md`)
- Learner → Workshop 7: opens (evidence: `README.md`)
- Learner → Workshop 8: opens (evidence: `README.md`)
- Workshop 1 → Model helpers: may use
- Workshop 2 → Model helpers: may use
- Workshop 3 → Model helpers: may use
- Workshop 4 → Model helpers: may use
- Workshop 5 → Model helpers: may use
- Workshop 6 → Model helpers: may use
- Workshop 7 → Model helpers: may use
- Workshop 8 → Model helpers: may use
- Model helpers → FloPy: uses (evidence: `helpers.py`)