Skip to main content

An Open-Source Python Toolkit for Automated Quantification of Corneal Nerve Fibers in Confocal Microscopy Images

Project description

description

English | 简体中文

SuperCCM Version 0.4.0

🚀 Introduction

✨️SuperCCM is an open-source Python framework for processing and analyzing corneal nerve images from corneal confocal microscopy (CCM). By providing a CCM corneal nerve image as input, SuperCCM can automatically process the image and output various clinically relevant morphological parameters. SuperCCM also allows fast and easy integration of independent algorithms (e.g., segmentation) into the framework.

🏠 Github: https://github.com/qlnfm/SuperCCM

❇️ Environment Setup

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

⚡ Quick Start

from superccm import DefaultWorkFlow

wf = DefaultWorkFlow()
metrics = wf.run('your/img/path')
print(metrics)

Or a simpler, less formal version:

from superccm.api import analysis

metrics = analysis('your/img/path')
print(metrics)

📖 Documentation & Tutorials

SuperCCM follows a principle of simplicity, allowing users and developers to get started and master it with minimal cost and time.

  • ✨️ Quick Tutorial: Learn how to use SuperCCM in detail
  • ✨️ Module Development: Learn how to customize workflows and integrate your own algorithms into SuperCCM

📄 License

This project is licensed under the GPL v3 open-source license.

🎓 Academic Citation

coming soon ...

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

superccm-0.4.0.tar.gz (53.4 MB view details)

Uploaded Source

Built Distribution

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

superccm-0.4.0-py3-none-any.whl (53.5 MB view details)

Uploaded Python 3

File details

Details for the file superccm-0.4.0.tar.gz.

File metadata

  • Download URL: superccm-0.4.0.tar.gz
  • Upload date:
  • Size: 53.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for superccm-0.4.0.tar.gz
Algorithm Hash digest
SHA256 b694fb9d8b914baea5295fd146f8dc2123c6ff107f43b298bb83ab375c881f3f
MD5 036881f50f6e828912353a9350c9c01a
BLAKE2b-256 f5ae322c045301bcd2f6eb49628a89f767dd31342bf6bfcf06d71ba7b965c6e6

See more details on using hashes here.

File details

Details for the file superccm-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: superccm-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 53.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for superccm-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b2f516aa9ca38306d508010aaeb90514f09b4cb7b3abe709b33de2ca876734a9
MD5 d8b8acf746e78c750391fcdfb5a36c6f
BLAKE2b-256 570930d01b9ace0175b1fbb85313999b7691037ac655606aef0366a916b5fa62

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