# borislouis/simulation_brownian_nanoparticles architecture

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

- Interactive diagram: https://gitdiagram.com/borislouis/simulation_brownian_nanoparticles
- Repository: https://github.com/borislouis/simulation_brownian_nanoparticles

## Overview

This repository is a notebook-based fluorescent-particle simulator. The documented workflow configures physical parameters, simulates Brownian motion, renders microscopy frames with a defocus-aware PSF, adds noise, and saves a movie and particle traces. The README supports these stage relationships, but no notebook source was provided, so implementation details and the relationship between the two notebooks remain unverified.

Main entry points: [`DiffusionSimulation.ipynb`](https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb) (Simulation notebook)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interaction["Configuration"]
  node_notebook["Simulation notebook"]
  node_local_notebook["Local notebook"]
end

subgraph group_simulation["Simulation"]
  node_brownian["Brownian motion"]
end

subgraph group_imaging["Image generation"]
  node_psf_render["PSF rendering"]
  node_noise["Noise addition"]
end

subgraph group_outputs["Results"]
  node_movie["TIFF movie"]
  node_traces["Particle traces"]
end

node_user(("User"))
node_colab["Colab GPU runtime"]
node_drive[("Google Drive results")]

node_user -->|"configures and runs"| node_notebook
node_notebook -->|"runs on"| node_colab
node_notebook -->|"simulates"| node_brownian
node_brownian -->|"renders frames"| node_psf_render
node_psf_render -->|"adds noise"| node_noise
node_noise -->|"saves TIFF"| node_movie
node_notebook -->|"saves traces"| node_traces
node_notebook -->|"stores results"| node_drive

click node_notebook "https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb"
click node_local_notebook "https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/Local_DiffusionSimulation.ipynb"
click node_brownian "https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb"
click node_psf_render "https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb"
click node_noise "https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb"

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_notebook,node_local_notebook,node_user toneBlue
class node_brownian,node_drive toneAmber
class node_psf_render,node_noise toneMint
class node_movie,node_traces toneRose
class node_colab toneIndigo
```

## Components

### Configuration

- [Simulation notebook](https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb): `DiffusionSimulation.ipynb`
- [Local notebook](https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/Local_DiffusionSimulation.ipynb): `Local_DiffusionSimulation.ipynb`

### Simulation

- [Brownian motion](https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb): `DiffusionSimulation.ipynb`

### Image generation

- [PSF rendering](https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb): `DiffusionSimulation.ipynb`
- [Noise addition](https://github.com/borislouis/simulation_brownian_nanoparticles/blob/main/DiffusionSimulation.ipynb): `DiffusionSimulation.ipynb`

### Results

- **TIFF movie**
- **Particle traces**

### Other components

- **User**
- **Colab GPU runtime**
- **Google Drive results**

## Connections

- User → Simulation notebook: configures and runs (evidence: `Readme.md`)
- Simulation notebook → Colab GPU runtime: runs on (evidence: `Readme.md`)
- Simulation notebook → Brownian motion: simulates (evidence: `Readme.md`)
- Brownian motion → PSF rendering: renders frames (evidence: `Readme.md`)
- PSF rendering → Noise addition: adds noise (evidence: `Readme.md`)
- Noise addition → TIFF movie: saves TIFF (evidence: `Readme.md`)
- Simulation notebook → Particle traces: saves traces (evidence: `Readme.md`)
- Simulation notebook → Google Drive results: stores results (evidence: `Readme.md`)
