VLab4Mic: A Virtual Laboratory for Microscopy
A friendly toolkit to help researchers simulate fluorescence microscopy images, no coding required.

VLab4Mic lets you explore, test, and validate imaging experiments before stepping into the microscope room.
Whether you are new to Python or an experienced bioimage researcher, VLab4Mic provides a safe sandbox to:
- Build virtual samples from PDB/CIF structures
- Apply direct or indirect fluorescent labeling
- Introduce Structural integrity, crowding, and structural variation
- Simulate image acquisition across modalities
- Run parameter sweeps to explore experimental conditions
- Compare noiseless vs. realistic acquisitions
This README is written to be friendly for beginners while maintaining the technical depth experienced users expect.

Who Is This Tool For?
- New microscopy users: to gain intuitive understanding without coding
- Researchers designing experiments: testing probes, PSFs, exposure times
- Microscopy experts: benchmarking reconstruction methods or PSFs
๐ Quick Start Options
| Option |
Skills Needed |
Best For |
| 1. Google Colab |
None |
Beginners, teaching, quick experiments |
| 2. LabConstrictor Desktop App |
None |
One-click install, no Python required |
| 3. Local Jupyter Notebooks |
Basic installation |
Smooth widget-based use |
| 4. Python Scripts |
Comfortable with code |
Full flexibility & automation |
๐ข Option 1 โ Google Colab (No Installation Needed)
The easiest way to start.
โ No installation
โ No configuration
โ Works in browser
โ Always up to date
๐ Click to open the main notebook:
Video Tutorials
| Tutorial |
Video |
| Tutorial 1 |
 |
| Tutorial 2 |
 |
| Tutorial 3 |
 |
If the Colab link fails:
- Click the Jupyter badge (opens the raw notebook)
- Download the
.ipynb file
- Open Google Colab โ File โ Upload notebook
๏ฟฝ Option 2 โ LabConstrictor Desktop App (No Python Required)
The easiest way to run VLab4Mic locally โ no Python, no conda, no terminal.
โ One-click installer (Windows & macOS)
โ No Python or environment setup
โ Notebooks bundled and ready to run
โ Automatic version checks
๐ Download and install:
Follow the installation instructions at:
https://github.com/HenriquesLab/LabConstrictor-VLab4Mic/blob/main/.tools/docs/download_executable.md
Powered by LabConstrictor โ a CI/CD-based pipeline that packages Jupyter notebooks into installable desktop applications (Hidalgo-Cenalmor et al., 2026).
๐ต Option 3 โ Local Installation (Beginner-Friendly)
1๏ธโฃ Create a virtual environment
We recommend using Python's built-in venv. Conda or a similar environment
manager can also be used if you prefer.
Using venv:
Run the following command to create a local .venv environment:
Then activate it:
source .venv/bin/activate
2๏ธโฃ Install VLab4Mic and its associated library to use the codeless jupyter notebooks
pip install vlab4mic "vlab4micjupyter[local]"
Installation time depends on your hardware and internet connection, but should take around 3 minutes.
VLab4Mic downloads required PDB/CIF structure files on first use and stores them
in your user folder at ~/.vlab4mic/structures. To use a different location,
set VLAB4MIC_STRUCTURE_DIR before running VLab4Mic.
3๏ธโฃ Launch Jupyter Lab
4๏ธโฃ Download and open notebooks
From:
https://github.com/HenriquesLab/VLab4Mic/tree/main/notebooks
๐ด Option 4 โ Use VLab4Mic as a Python Library (Advanced)
Example script:
from vlab4mic.experiments import image_vsample
import matplotlib.pyplot as plt
modalities = ["Widefield", "Confocal", "STED"]
images, noiseless, experiment = image_vsample(
structure="7R5K",
probe_template="Antibody",
probe_target_type="Sequence",
probe_target_value="ELAVGSL",
multimodal=modalities,
number_of_particles=10,
run_simulation=True,
)
fig, axs = plt.subplots(1, len(modalities))
for i, mod in enumerate(modalities):
axs[i].imshow(images[mod][0], cmap="magma")
axs[i].set_title(mod)
plt.show()
For more examples see /examples.
When running example scripts, total runtime depends on your hardware and internet connection, but should take around 5 minutes.
Documentation & Manual
Core Features
โ Structural modelling
โ Virtual sample creation
โ Imaging simulations
โ Parameter sweeps
โ Widget-based GUI
โ Flexible Python API
Troubleshooting
Jupyter won't open โ Environment not activated.
ImportError โ Install VLab4Mic inside the active environment.
Colab won't load โ Upload notebook manually.
If issues persist, open an issue!
Contributing
Contributions welcome!
See: https://github.com/HenriquesLab/VLab4Mic/blob/main/CONTRIBUTING.md
Support
Citation
If you use VLab4Mic in your research, please cite:
@article{martinez_2026_vlab4mic,
title={VLab4Mic: prediction of structural resolvability in super-resolution microscopy},
author={Mart{\'i}nez, Dami{\'a}n and Saraiva, Bruno M. and Shakespeare, Tayla and
Bates, Mark and Owen, Dylan M. and Leterrier, Christophe and
Del Rosario, Mario and Henriques, Ricardo},
year={2026},
journal={bioRxiv},
doi={10.64898/2026.06.02.729521},
url={https://www.biorxiv.org/content/10.64898/2026.06.02.729521v1}
}