Skip to main content

mAIcrobe

Project description

License BSD-3 PyPI Python Version tests napari hub Website Preprint

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. Built using Python 3.10 and 3.11 and tested on Windows, and macOS.

You can read more about mAIcrobe in our preprint.

Video Showcase

Video

✨ Why mAIcrobe?

🔬 For Microbiologists

  • Automated Cell Segmentation: StarDist2D, Cellpose, and custom U-Net models. Several pre-trained models also included.
  • Deep learning classification: 6 pre-trained CNN models for S. aureus cell cycle determination, a pre-trained model for E. coli antibiotic phenotyping 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
  • Timelapse Analysis: 2D+t workflows with optional registration and label reassignment
  • Batch Processing: Analyze one folder containing multiple FoVs with merged outputs
  • Automated Reports: HTML reports with visualizations and statistics
  • Data Export: CSV export for downstream statistical analysis

🚀 Installation

Standard Installation:

We recommend using an environment manager like conda to handle dependencies and assure reproducibility.

Regardless of environment, you can install via pip in Python 3.10 or 3.11. This should handle all dependencies and might take a couple of minutes depending on your internet connection.

pip install napari-mAIcrobe

Development Installation:

git clone https://github.com/HenriquesLab/mAIcrobe.git
cd mAIcrobe
pip install -e .

🎯 Detailed Installation Instructions →

🏆 Key Features

🎨 Cell Segmentation

  • Thresholding: Isodata and Local Average methods with watershed
  • StarDist2D: custom models (pretrained available for S. aureus)
  • Cellpose: cyto3 model
  • Custom U-Net Models: custom models (pretrained available for S. aureus, B. subtilis, and S. pneumoniae)

🧠 Single cell Classification

  • Pre-trained Models: S. aureus cell cycle and E. coli antibiotic phenotyping
  • Custom Model Support: Build your training dataset in napari with out custom widget, train using our jupyter notebook and load your own TensorFlow models,

📊 Comprehensive Morphometry

  • Shape Analysis: Area, perimeter, eccentricity
  • Intensity Measurements: Fluorescence statistics
  • Custom Measurements: Septum detection, colocalization, and more

📖 Documentation

Guide Purpose
🚀 Getting Started Installation to first analysis using sample data
🔬 Segmentation Guide Explore the available segmentation methods
📊 Cell Analysis Explore complete analysis workflow and check the metrics measured
🧠 Cell Classification Guide Explore the available classification models
⏱️ Timelapse Analysis Analyze (T, Y, X) data with optional registration and relabeling
📁 Batch Analysis Workflow Process many FoVs from one root folder and export merged tables
Tutorial Purpose
🎨 Basic Workflow Step-by-step guide with a simple example (<5 minutes)
🛠️ Generate Training Data Create annotated datasets for custom model training
Video Purpose
🎨 Basic Workflow Step-by-step guide with a simple example (<5 minutes)
🛠️ Full workflow Full workflow from installation to export of results
🧠 How to retrain the classifier Create annotated datasets, train your custom model and use it in mAIcrobe

For programmatic usage: | ⚙️ API Reference

📚 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 → | ⏱️ Timelapse Guide → | 📁 Batch Workflow → | ⚙️ 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.1.0.tar.gz (75.2 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.1.0-py3-none-any.whl (87.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for napari_maicrobe-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1a639686f4d04e1b58b728112f0b7644609fddd730698638fc67adc60f3a6ceb
MD5 6192d74bf53caa81e3e0d18b5b51d799
BLAKE2b-256 af676b4e2dbb3f5b09823000920fedd2f5e0bb14646e738b740c52f9133869b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for napari_maicrobe-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 adf1b8d39417ed9102468b7e437ace044490d1b45459a534c710243c1bd94ecd
MD5 ac8404ac467f5344e676108701e115bf
BLAKE2b-256 16f30acc2cce51eb43ea35decbf1c8c502e9e6e886ec0661f010b3310921bb9b

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