mAIcrobe
Project description
mAIcrobe
mAIcrobe: a napari plugin for microbial image analysis.
mAIcrobe is a comprehensive napari plugin that facilitates image analysis workflows of bacterial cells. Combining state-of-the-art segmentation approaches, morphological analysis and adaptable classification models into a napari-plugin, mAIcrobe aims to deliver a user-friendly interface that helps inexperienced users perform image analysis tasks regardless of the bacterial species and microscopy modality.
✨ Why mAIcrobe?
🔬 For Microbiologists
- Automated Cell Segmentation: StarDist2D, Cellpose, and custom U-Net models
- Deep learning classification: 6 pre-trained CNN models for S. aureus cell cycle determination plus support for custom models
- Morphological Analysis: Comprehensive measurements using scikit-image regionprops
- Interactive Filtering: Real-time cell selection based on computed statistics
📊 For Quantitative Research
- Colocalization Analysis: Multi-channel fluorescence quantification
- Automated Reports: HTML reports with visualizations and statistics
- Data Export: CSV export for downstream statistical analysis
🚀 Installation
Standard Installation:
pip install napari-mAIcrobe
Development Installation:
git clone https://github.com/HenriquesLab/mAIcrobe.git
cd mAIcrobe
pip install -e .
🏆 Key Features
🎨 Cell Segmentation
- Thresholding: Isodata and Local Average methods with watershed
- StarDist2D: custom models
- Cellpose: cyto3 model
- Custom U-Net Models: custom models
🧠 Single cell Classification
- Pre-trained Models: 6 specialized models for cell cycle determination in S. aureus:
- DNA+Membrane (Epifluorescence & SIM)
- DNA-only (Epifluorescence & SIM)
- Membrane-only (Epifluorescence & SIM)
- Custom Model Support: Load your own TensorFlow models
📊 Comprehensive Morphometry
- Shape Analysis: Area, perimeter, eccentricity
- Intensity Measurements: Fluorescence statistics
- Custom Measurements: Septum detection
📖 Documentation
| Guide | Purpose |
|---|---|
| 🚀 Getting Started | Installation to first analysis |
| 🔬 Segmentation Guide | Choose the right segmentation method |
| 📊 Cell Analysis | Complete analysis workflows |
| 🧠 Cell Classification Guide | Cell cycle classification setup |
| ⚙️ API Reference | Programmatic usage |
🎯 Analysis Workflow
📄 Single Image Analysis
- Load Images: Phase contrast and/or fluorescence
- Segment Cells: Choose segmentation algorithm and parameters
- Analyze Cells: Extract morphological and intensity features and choose classification model
- Filter Results: Interactive filtering of cell populations
- Generate Report: Create comprehensive analysis report
🧪 Sample Data
The plugin includes test datasets for method validation:
- Phase Contrast: S. aureus cells in exponential growth
- Membrane Stain: NileRed fluorescence imaging
- DNA Stain: Hoechst nuclear labeling
Access via napari: File > Open Sample > napari-mAIcrobe
🏃♀️ Example Analysis
Input Data:
- Phase contrast image
- Membrane fluorescence
- DNA fluorescence
Analysis Pipeline:
- Segmentation: Isodata or CellPose's cyto3 identifies individual cells in the phase contrast image
- Morphology: Calculate morphological and intensity measurements
- Classification: Cell cycle phase determination using pre-trained CNN model
- Quality Control: Interactive filtering of analysis results. Select subpopulations based on size, intensity, or classification
- Report Generation: HTML output
📚 Available Jupyter Notebooks
Explore advanced functionality with included notebooks:
- Cell Cycle Model Training: Train custom classification models
- StarDist Segmentation: Retrain a StarDist segmentation model
🤝 Community
- 🐛 Issues - Report bugs, request features
- 📚 napari hub - Plugin ecosystem
🏗️ Contributing
We welcome contributions! Whether it's:
- 🐛 Bug reports and fixes
- ✨ New segmentation algorithms
- 📖 Documentation improvements
- 🧪 Additional test datasets
- 🤖 New AI models for classification
Quick contributor setup:
git clone https://github.com/HenriquesLab/mAIcrobe.git
cd mAIcrobe
pip install -e .[testing]
pre-commit install
Testing:
# Run tests
pytest -v
# Run tests with coverage
pytest --cov=napari_mAIcrobe
# Run tests across Python versions
tox
📜 License
Distributed under the terms of the BSD-3 license, mAIcrobe is free and open source software.
🙏 Acknowledgments
mAIcrobe is developed in the Henriques and Pinho Labs with contributions from the napari and scientific Python communities.
Built with:
- napari - Multi-dimensional image viewer
- TensorFlow - Machine learning framework
- StarDist - Object detection with star-convex shapes
- Cellpose - Generalist cell segmentation
- scikit-image - Image processing library
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file napari_maicrobe-0.0.3.tar.gz.
File metadata
- Download URL: napari_maicrobe-0.0.3.tar.gz
- Upload date:
- Size: 43.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
48a653c23dbc38440a359702cc84ac13ef962f7e5ac463a71fa70ac196d2b00d
|
|
| MD5 |
c6541ba4a153e96fbac5acd10f35fa6c
|
|
| BLAKE2b-256 |
3131212e59a978616c86b92160c1bb179d51188e81320dc629917353124596aa
|
File details
Details for the file napari_maicrobe-0.0.3-py3-none-any.whl.
File metadata
- Download URL: napari_maicrobe-0.0.3-py3-none-any.whl
- Upload date:
- Size: 47.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a7ae61aa8db73a70e9e02eb9028e92d661ea82a1e90b8e388f0e4678a484fa22
|
|
| MD5 |
7476cd36d2e6d7d217bae244a7d7bb22
|
|
| BLAKE2b-256 |
0a3473e54933a5e7932061d1ec72a5d17eb3eb8bebb09dd323e7f28fa7b96d6d
|