README_PYPI.md

ParticleAnalyzer

ParticleAnalyzer Is A Computer Vision-Based Tool for Automatic Segmentation and Size Analysis of Nanoparticles in Scanning Electron Microscope (SEM) and Transmission Electron Microscope (TEM) Images.

---

🎬 Demonstration

Video demonstrations:
▶️ Local video (MP4) | ▶️ YouTube demonstration

---

🛠 Installation Guide

1. 📥 Install PyTorch with CUDA support

Make sure your system has an NVIDIA GPU with CUDA. Install PyTorch using the appropriate CUDA version (e.g., CUDA 11.8):

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118

If you do not have a CUDA-capable GPU, use the CPU version instead—however, in this case, ParticleAnalyzer will run significantly slower:

pip install torch torchvision torchaudio

🧪 2. Install Detectron2 (Optional)

If you want to enable advanced instance segmentation, install Detectron2:

pip install 'git+https://github.com/facebookresearch/detectron2.git'

Warning

There may be problems installing Detectron2. Use the official documentation.

📦 3. Install ParticleAnalyzer

Finally, install ParticleAnalyzer from PyPI:

pip install --upgrade ParticleAnalyzer

✅ Now you're ready to run the application:

ParticleAnalyzer run

Open in browser: http://127.0.0.1:8000

You can specify the port if necessary:

ParticleAnalyzer run --port 5000

Launch with LLM support (OpenRouter or Hugging Face API key required):

ParticleAnalyzer run --port 5000 --api-key YOUR_OPENROUTER_API_KEY