# henriqueslab/zerocostdl4mic architecture

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

- Interactive diagram: https://gitdiagram.com/henriqueslab/zerocostdl4mic
- Repository: https://github.com/henriqueslab/zerocostdl4mic

## Overview

ZeroCostDL4Mic is a collection of Colab Jupyter notebooks that gives microscopy researchers GUI-guided access to deep-learning workflows, alongside standalone microscopy utilities and BioImage.IO catalog tooling. The main user path is to open a model notebook, provide microscopy data, and use or train a network. README evidence supports this broad workflow and the Colab context; sampled tools provide more specific implementation evidence. Notebook internals were not sampled, so their internal data flow is not expanded here.

Main entry points: [`manifest.bioimage.io.yaml`](https://github.com/henriqueslab/zerocostdl4mic/blob/master/manifest.bioimage.io.yaml) (Collection manifest), [`Tools/Automated_tracking/Automated_tracking.py`](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/Automated_tracking/Automated_tracking.py) (TrackMate automation), [`Tools/parser_dicts_variables.py`](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/parser_dicts_variables.py) (Notebook version map), [`Tools/export_bmz_notebook.py`](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/export_bmz_notebook.py) (Notebook exporter)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_notebooks["Microscopy notebooks"]
  node_model_notebooks["Model notebooks"]
  node_denoising["Denoising"]
  node_restoration["Restoration"]
  node_segmentation["Segmentation"]
  node_detection["Detection"]
  node_generative["Generative models"]
  node_interactive_annotation["Interactive annotation"]
end

subgraph group_tools["Microscopy utilities"]
  node_tracking["TrackMate automation"]
  node_voc_converter["VOC to COCO<br/>[voc2coco.py]"]
end

subgraph group_catalog["BioImage.IO catalog"]
  node_manifest["Collection manifest"]
  node_exporter["Notebook exporter"]
  node_version_map["Notebook version map"]
  node_version_check["Version checker"]
  node_manifest_versioning["Manifest versioning"]
  node_manifest_sync["Manifest sync"]
  node_collection_staging["Collection staging"]
end

node_researcher(("Researcher"))
node_colab["Google Colab"]
node_imagej["ImageJ / TrackMate"]
node_microscopy_data["Microscopy images"]
node_annotation_files["VOC annotations"]
node_coco_json["COCO JSON"]
node_bioimage_collection["BioImage.IO collection"]

node_researcher -->|"opens notebooks"| node_model_notebooks
node_model_notebooks -->|"runs on"| node_colab
node_researcher -->|"chooses model"| node_denoising
node_researcher -->|"chooses model"| node_restoration
node_researcher -->|"chooses model"| node_segmentation
node_researcher -->|"chooses model"| node_detection
node_researcher -->|"chooses model"| node_generative
node_researcher -->|"opens notebook"| node_interactive_annotation
node_microscopy_data -->|"input images"| node_tracking
node_tracking -->|"uses TrackMate"| node_imagej
node_tracking -->|"writes track CSVs"| node_researcher
node_annotation_files -->|"provides XML"| node_voc_converter
node_voc_converter -->|"writes JSON"| node_coco_json
node_exporter -->|"reads collection"| node_manifest
node_exporter -->|"packages resource"| node_bioimage_collection
node_version_check -->|"uses mapping"| node_version_map
node_version_check -->|"checks versions"| node_manifest
node_manifest_versioning -->|"uses mapping"| node_version_map
node_manifest_versioning -->|"updates versions"| node_manifest
node_manifest_sync -->|"uses mapping"| node_version_map
node_manifest_sync -->|"updates config"| node_manifest
node_collection_staging -->|"dispatches staging"| node_bioimage_collection

click node_model_notebooks "https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks"
click node_denoising "https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks"
click node_restoration "https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks"
click node_segmentation "https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks"
click node_detection "https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks"
click node_generative "https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks"
click node_interactive_annotation "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Colab_notebooks/ZeroCostDL4Mic_Interactive_annotations_Cellpose.ipynb"
click node_tracking "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/Automated_tracking/Automated_tracking.py"
click node_voc_converter "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/voc2coco.py"
click node_manifest "https://github.com/henriqueslab/zerocostdl4mic/blob/master/manifest.bioimage.io.yaml"
click node_exporter "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/export_bmz_notebook.py"
click node_version_map "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/parser_dicts_variables.py"
click node_version_check "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/check_outdated_notebooks.py"
click node_manifest_versioning "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/update_manifest_versioning.py"
click node_manifest_sync "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/update_manifest_dl4miceverywhere.py"
click node_collection_staging "https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/stage_bmz_notebook.py"

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_model_notebooks,node_denoising,node_restoration,node_segmentation,node_detection,node_generative,node_interactive_annotation toneBlue
class node_tracking,node_voc_converter toneAmber
class node_manifest,node_exporter,node_version_map,node_version_check,node_manifest_versioning,node_manifest_sync,node_collection_staging toneMint
class node_researcher,node_colab,node_imagej,node_microscopy_data,node_annotation_files,node_coco_json,node_bioimage_collection toneIndigo
```

## Components

### Microscopy notebooks

- [Model notebooks](https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks): `Colab_notebooks`
- [Denoising](https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks): `Colab_notebooks`
- [Restoration](https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks): `Colab_notebooks`
- [Segmentation](https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks): `Colab_notebooks`
- [Detection](https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks): `Colab_notebooks`
- [Generative models](https://github.com/henriqueslab/zerocostdl4mic/tree/master/Colab_notebooks): `Colab_notebooks`
- [Interactive annotation](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Colab_notebooks/ZeroCostDL4Mic_Interactive_annotations_Cellpose.ipynb): `Colab_notebooks/ZeroCostDL4Mic_Interactive_annotations_Cellpose.ipynb`

### Microscopy utilities

- [TrackMate automation](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/Automated_tracking/Automated_tracking.py): `Tools/Automated_tracking/Automated_tracking.py`
- [VOC to COCO](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/voc2coco.py): `Tools/voc2coco.py`

### BioImage.IO catalog

- [Collection manifest](https://github.com/henriqueslab/zerocostdl4mic/blob/master/manifest.bioimage.io.yaml): `manifest.bioimage.io.yaml`
- [Notebook exporter](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/export_bmz_notebook.py): `Tools/export_bmz_notebook.py`
- [Notebook version map](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/parser_dicts_variables.py): `Tools/parser_dicts_variables.py`
- [Version checker](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/check_outdated_notebooks.py): `Tools/check_outdated_notebooks.py`
- [Manifest versioning](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/update_manifest_versioning.py): `Tools/update_manifest_versioning.py`
- [Manifest sync](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/update_manifest_dl4miceverywhere.py): `Tools/update_manifest_dl4miceverywhere.py`
- [Collection staging](https://github.com/henriqueslab/zerocostdl4mic/blob/master/Tools/stage_bmz_notebook.py): `Tools/stage_bmz_notebook.py`

### Other components

- **Researcher**
- **Google Colab**
- **ImageJ / TrackMate**
- **Microscopy images**
- **VOC annotations**
- **COCO JSON**
- **BioImage.IO collection**

## Connections

- Researcher → Model notebooks: opens notebooks (evidence: `README.md`)
- Model notebooks → Google Colab: runs on (evidence: `README.md`)
- Researcher → Denoising: chooses model (evidence: `README.md`)
- Researcher → Restoration: chooses model (evidence: `README.md`)
- Researcher → Segmentation: chooses model (evidence: `README.md`)
- Researcher → Detection: chooses model (evidence: `README.md`)
- Researcher → Generative models: chooses model (evidence: `README.md`)
- Researcher → Interactive annotation: opens notebook (evidence: `README.md`)
- Microscopy images → TrackMate automation: input images (evidence: `Tools/Automated_tracking/Automated_tracking.py`)
- TrackMate automation → ImageJ / TrackMate: uses TrackMate (evidence: `Tools/Automated_tracking/Automated_tracking.py`)
- TrackMate automation → Researcher: writes track CSVs (evidence: `Tools/Automated_tracking/Automated_tracking.py`)
- VOC annotations → VOC to COCO: provides XML (evidence: `Tools/voc2coco.py`)
- VOC to COCO → COCO JSON: writes JSON (evidence: `Tools/voc2coco.py`)
- Notebook exporter → Collection manifest: reads collection (evidence: `Tools/export_bmz_notebook.py`)
- Notebook exporter → BioImage.IO collection: packages resource (evidence: `Tools/export_bmz_notebook.py`)
- Version checker → Notebook version map: uses mapping (evidence: `Tools/check_outdated_notebooks.py`)
- Version checker → Collection manifest: checks versions (evidence: `Tools/check_outdated_notebooks.py`)
- Manifest versioning → Notebook version map: uses mapping (evidence: `Tools/update_manifest_versioning.py`)
- Manifest versioning → Collection manifest: updates versions (evidence: `Tools/update_manifest_versioning.py`)
- Manifest sync → Notebook version map: uses mapping (evidence: `Tools/update_manifest_dl4miceverywhere.py`)
- Manifest sync → Collection manifest: updates config (evidence: `Tools/update_manifest_dl4miceverywhere.py`)
- Collection staging → BioImage.IO collection: dispatches staging (evidence: `Tools/stage_bmz_notebook.py`)
