Skip to main content

mAIcrobe

Project description

License BSD-3 PyPI Python Version tests napari hub

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 .

🎯 Complete Tutorial →

🏆 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

  1. Load Images: Phase contrast and/or fluorescence
  2. Segment Cells: Choose segmentation algorithm and parameters
  3. Analyze Cells: Extract morphological and intensity features and choose classification model
  4. Filter Results: Interactive filtering of cell populations
  5. 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:

  1. Segmentation: Isodata or CellPose's cyto3 identifies individual cells in the phase contrast image
  2. Morphology: Calculate morphological and intensity measurements
  3. Classification: Cell cycle phase determination using pre-trained CNN model
  4. Quality Control: Interactive filtering of analysis results. Select subpopulations based on size, intensity, or classification
  5. Report Generation: HTML output

📚 Available Jupyter Notebooks

Explore advanced functionality with included notebooks:

🤝 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

📋 Full Contributing Guide →

📜 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:


🔬 From the Henriques and Pinho Labs

"Advancing microbiology through AI-powered image analysis."

🚀 Get Started → | 📚 Learn More → | ⚙️ API Docs →

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

napari_maicrobe-0.0.5.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_maicrobe-0.0.5-py3-none-any.whl (47.9 kB view details)

Uploaded Python 3

File details

Details for the file napari_maicrobe-0.0.5.tar.gz.

File metadata

  • Download URL: napari_maicrobe-0.0.5.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for napari_maicrobe-0.0.5.tar.gz
Algorithm Hash digest
SHA256 5bfd98c1ff268bb6f5127f7f884fc0d908c662202421940f76a5cb9448a35f79
MD5 cc4f4c5871e6adeeb7f2bdd4d247505f
BLAKE2b-256 e31260b773614a141d47036c4442935ae99dca5cc528a7d42393eae85d488e59

See more details on using hashes here.

File details

Details for the file napari_maicrobe-0.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_maicrobe-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a0fa754a73fdf5818612b991dcf9c326c8f6d748f59fd1443967ba2fbb79de43
MD5 d63623f92c09c657bcf902b6cdc2a709
BLAKE2b-256 1b8cc868138e34b95c63ea6212b268f2c16cd2204341a60d519952219d292fef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page