Metadata-Version: 2.4
Name: superccm
Version: 0.2.1
Summary: An Open-Source Python Toolkit for Automated Quantification of Corneal Nerve Fibers in Confocal Microscopy Images
Home-page: https://https://github.com/SummerColdWind
Author: Qincheng Qiao
Author-email: jugking6688@gmail.com
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiccm
Requires-Dist: gradio==5.35.0
Requires-Dist: matplotlib==3.7.0
Requires-Dist: numpy<2.0.0
Requires-Dist: scikit-learn==1.7.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<div align="center">
  <img src="docs/assets/superccm.png" alt="description" />

<hr>

[English](./README.md) | 简体中文
</div>

## 🚀 Introduction

✨️SuperCCM is an open-source Python framework for processing and analyzing corneal nerve images from corneal confocal microscopy (CCM). By inputting a CCM corneal nerve image, SuperCCM can automatically process the image and output various commonly used morphological parameters in clinical practice.
### 🏠Github: https://github.com/qlnfm/SuperCCM

## ❇️ Environmental Preparation

```shell
conda create -n superccm python=3.10 -y
conda activate superccm
pip install -r requirements.txt
```
 - Install from PyPI
```shell
pip install superccm
```

## 🌟 Using online

> https://huggingface.co/spaces/jugking6688/SuperCCM

## ⚡ Quickly Start

```python
from superccm import SuperCCM

ccm = SuperCCM()
metrics = ccm.run('your/img/path')
print(metrics)
```
 - Just a few lines of commands are needed.

## 📖 Document Tutorial

 - ✨️ [Advanced Tutorial](docs/doc_cn_auto_analysis.md): Gain a thorough understanding of the use of SuperCCM
 - ✨️ [Module writing](docs/doc_cn_auto_analysis.md): Learn how to customize the workflow and integrate your developed algorithms into SuperCCM

## 📄 License

This project follows the [GPL v3](LICENSE) open source license.

## 🎓 Academic Citation

> coming soon ...
