# ParticleAnalyzer
[](https://sem.rybakov-k.ru/)
**ParticleAnalyzer** is a computer vision tool for automatic particle segmentation and size analysis in Scanning Electron Microscope (SEM) images.
---
## 🎬 Demonstration
<p align="center">
<strong>Video demonstrations:</strong><br>
<a href="https://github.com/rybakov-ks/ParticleAnalyzer/blob/main/Images/ParticleAnalyzer.mp4">▶️ Local video (MP4)</a> |
<a href="https://youtu.be/qlCuZDjDyqk">▶️ YouTube demonstration</a>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/rybakov-ks/ParticleAnalyzer/main/Images/example.gif" alt="Example" width="600">
</p>
---
## 🛠 Installation Guide
### 1. 📥 Install PyTorch with CUDA support
Make sure your system has an NVIDIA GPU with CUDA. Install [PyTorch](https://pytorch.org/get-started/locally/) using the appropriate CUDA version (e.g., CUDA 11.8):
```python
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:
```python
pip install torch torchvision torchaudio
```
### 🧪 2. Install Detectron2 (Optional)
If you want to enable advanced instance segmentation, install Detectron2:
```python
pip install 'git+https://github.com/facebookresearch/detectron2.git'
```
> [!WARNING]
> *There may be problems installing Detectron2. Use the official [documentation](https://detectron2.readthedocs.io/en/latest/tutorials/install.html).*
### 📦 3. Install ParticleAnalyzer
Finally, install ParticleAnalyzer from PyPI:
```python
pip install ParticleAnalyzer
```
✅ Now you're ready to run the application:
```python
ParticleAnalyzer run
```
Open in browser: http://127.0.0.1:8000
You can specify the port if necessary:
```python
ParticleAnalyzer run --port 5000
```
Launch with LLM support ([OpenRouter](https://openrouter.ai/settings/keys) or [Hugging Face](https://huggingface.co/settings/tokens) API key required):
```python
ParticleAnalyzer run --port 5000 --api-key YOUR_OPENROUTER_API_KEY
```
Raw data
{
"_id": null,
"home_page": "https://github.com/rybakov-ks/ParticleAnalyzer",
"name": "ParticleAnalyzer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "SEM, microscopy, image-analysis, particle-analysis, materials-science, nanoparticles, computer-vision, opencv, python, scientific-computing, microstructure, particle-size, image-processing, detectron2, YOLO, deep-learning, microscope-images, material-characterization, automated-measurements, research-tools",
"author": "Kirill Rybakov",
"author_email": "rybakov-ks@ya.ru",
"download_url": "https://files.pythonhosted.org/packages/84/25/8498c409f236384f90f59b2a8fe7fd72a547e3606622366c4df555413358/particleanalyzer-0.1.33.tar.gz",
"platform": null,
"description": "# ParticleAnalyzer\n\n[](https://sem.rybakov-k.ru/)\n\n**ParticleAnalyzer** is a computer vision tool for automatic particle segmentation and size analysis in Scanning Electron Microscope (SEM) images.\n\n---\n\n## \ud83c\udfac Demonstration\n\n<p align=\"center\">\n <strong>Video demonstrations:</strong><br>\n <a href=\"https://github.com/rybakov-ks/ParticleAnalyzer/blob/main/Images/ParticleAnalyzer.mp4\">\u25b6\ufe0f Local video (MP4)</a> | \n <a href=\"https://youtu.be/qlCuZDjDyqk\">\u25b6\ufe0f YouTube demonstration</a>\n</p>\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/rybakov-ks/ParticleAnalyzer/main/Images/example.gif\" alt=\"Example\" width=\"600\">\n</p>\n\n---\n\n## \ud83d\udee0 Installation Guide\n\n ### 1. \ud83d\udce5 Install PyTorch with CUDA support\nMake sure your system has an NVIDIA GPU with CUDA. Install [PyTorch](https://pytorch.org/get-started/locally/) using the appropriate CUDA version (e.g., CUDA 11.8):\n ```python\n pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118\n ```\nIf you do not have a CUDA-capable GPU, use the CPU version instead\u2014however, in this case, ParticleAnalyzer will run significantly slower:\n ```python\n pip install torch torchvision torchaudio\n ```\n### \ud83e\uddea 2. Install Detectron2 (Optional)\n\nIf you want to enable advanced instance segmentation, install Detectron2:\n```python\npip install 'git+https://github.com/facebookresearch/detectron2.git'\n```\n> [!WARNING]\n> *There may be problems installing Detectron2. Use the official [documentation](https://detectron2.readthedocs.io/en/latest/tutorials/install.html).*\n### \ud83d\udce6 3. Install ParticleAnalyzer\nFinally, install ParticleAnalyzer from PyPI:\n```python\npip install ParticleAnalyzer\n```\n\u2705 Now you're ready to run the application:\n```python\nParticleAnalyzer run\n```\nOpen in browser: http://127.0.0.1:8000 \n\nYou can specify the port if necessary:\n```python\nParticleAnalyzer run --port 5000\n```\n\nLaunch with LLM support ([OpenRouter](https://openrouter.ai/settings/keys) or [Hugging Face](https://huggingface.co/settings/tokens) API key required):\n```python\nParticleAnalyzer run --port 5000 --api-key YOUR_OPENROUTER_API_KEY\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "SEM Image Analysis Tool",
"version": "0.1.33",
"project_urls": {
"Bug Reports": "https://github.com/rybakov-ks/ParticleAnalyzer/issues",
"Homepage": "https://github.com/rybakov-ks/ParticleAnalyzer",
"Source": "https://github.com/rybakov-ks/ParticleAnalyzer"
},
"split_keywords": [
"sem",
" microscopy",
" image-analysis",
" particle-analysis",
" materials-science",
" nanoparticles",
" computer-vision",
" opencv",
" python",
" scientific-computing",
" microstructure",
" particle-size",
" image-processing",
" detectron2",
" yolo",
" deep-learning",
" microscope-images",
" material-characterization",
" automated-measurements",
" research-tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a69e40550e3c74444fd46dc6bfb8d594c1855d0e6540ed8a5532e1819b3f6e6b",
"md5": "c06e9a3bff58b93066bbdb5a5becc266",
"sha256": "aacd94accc26fffcb81e37635ec63675b3c6c4c3b263aa2628376f704c4fd5bf"
},
"downloads": -1,
"filename": "particleanalyzer-0.1.33-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c06e9a3bff58b93066bbdb5a5becc266",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 110896,
"upload_time": "2025-07-28T14:49:16",
"upload_time_iso_8601": "2025-07-28T14:49:16.966729Z",
"url": "https://files.pythonhosted.org/packages/a6/9e/40550e3c74444fd46dc6bfb8d594c1855d0e6540ed8a5532e1819b3f6e6b/particleanalyzer-0.1.33-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "84258498c409f236384f90f59b2a8fe7fd72a547e3606622366c4df555413358",
"md5": "ae574cda5c5812ed89948bf8c397e8bc",
"sha256": "2a78f2380de7496ab55229d2e1b9b84e3bbe4ae0a0922bb1c08845dd29dfed13"
},
"downloads": -1,
"filename": "particleanalyzer-0.1.33.tar.gz",
"has_sig": false,
"md5_digest": "ae574cda5c5812ed89948bf8c397e8bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 106060,
"upload_time": "2025-07-28T14:49:19",
"upload_time_iso_8601": "2025-07-28T14:49:19.583999Z",
"url": "https://files.pythonhosted.org/packages/84/25/8498c409f236384f90f59b2a8fe7fd72a547e3606622366c4df555413358/particleanalyzer-0.1.33.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 14:49:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rybakov-ks",
"github_project": "ParticleAnalyzer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "particleanalyzer"
}
JSON
