Skip to main content

MyoQuant🔬: a tool to automatically quantify pathological features in muscle fiber histology images.

Project description

Twitter Follow Demo Version PyPi Pypi verison PyPi Python Version PyPi Format GitHub last commit GitHub

MyoQuant🔬: a tool to automatically quantify pathological features in muscle fiber histology images

MyoQuant Banner

MyoQuant🔬 is a command-line tool to automatically quantify pathological features in muscle fiber histology images.
It is built using CellPose, Stardist, custom neural-network models and image analysis techniques to automatically analyze myopathy histology images. Currently MyoQuant is capable of quantifying centralization of nuclei in muscle fiber with HE staining and anomaly in the mitochondria distribution in muscle fibers with SDH staining.

An online demo with a web interface is available at https://lbgi.fr/MyoQuant/. This project is free and open-source under the AGPL license, feel free to fork and contribute to the development.

Warning: This tool is still in early phases and active development.

How to install

Installing from PyPi (Preferred)

MyoQuant package is officially available on PyPi (pip) repository. https://pypi.org/project/myoquant/ Pypi verison

Using pip, you can simply install MyoQuant in a python environment with a simple: pip install myoquant

Installing from sources (Developers)

  1. Clone this repository using git clone https://github.com/lambda-science/MyoQuant.git
  2. Create a virtual environment by using python -m venv .venv
  3. Activate the venv by using source .venv/bin/activate
  4. Install MyoQuant by using pip install -e .

How to Use

To use the command-line tool, first activate your venv in which MyoQuant is installed: source .venv/bin/activate
Then you can perform SDH or HE analysis. You can use the command myoquant --help to list available commands.

💡Full command documentation is avaliable here: CLI Documentation

  • For SDH Image Analysis the command is:
    myoquant sdh-analysis IMAGE_PATH
    Don't forget to run myoquant sdh-analysis --help for information about options.
  • For HE Image Analysis the command is:
    myoquant he-analysis IMAGE_PATH
    Don't forget to run myoquant he-analysis --help for information about options.

If you're running into an issue such as myoquant: command not found please check if you activated your virtual environment with the package installed. And also you can try to run it with the full command: python -m myoquant sdh-analysis --help

Contact

Creator and Maintainer: Corentin Meyer, 3rd year PhD Student in the CSTB Team, ICube — CNRS — Unistra corentin.meyer@etu.unistra.fr

Citing MyoQuant🔬

[placeholder]

Examples

For HE Staining analysis, you can download this sample image: HERE
For SDH Staining analysis, you can download this sample image: HERE

  1. Example of successful SDH analysis with: myoquant sdh-analysis sample_sdh.jpg

image

  1. Example of successful HE analysis with: myoquant he-analysis sample_he.jpg

image

Advanced information

Model path and manual download

For the SDH Analysis our custom model will be downloaded and placed inside the myoquant package directory. You can also download it manually here: https://lbgi.fr/~meyer/SDH_models/model.h5 and then you can place it in the directory of your choice and provide the path to the model file using:
myoquant sdh-analysis IMAGE_PATH --model_path /path/to/model.h5

HuggingFace🤗 repositories for Data and Model

In a effort to push for open-science, MyoQuant SDH dataset and model and availiable on HuggingFace🤗

Partners

Partner Banner

MyoQuant is born within the collaboration between the CSTB Team @ ICube led by Julie D. Thompson, the Morphological Unit of the Institute of Myology of Paris led by Teresinha Evangelista, the imagery platform MyoImage of Center of Research in Myology led by Bruno Cadot, the photonic microscopy platform of the IGMBC led by Bertrand Vernay and the Pathophysiology of neuromuscular diseases team @ IGBMC led by Jocelyn Laporte

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

myoquant-0.2.0.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

myoquant-0.2.0-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

Details for the file myoquant-0.2.0.tar.gz.

File metadata

  • Download URL: myoquant-0.2.0.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.10.6 Linux/5.10.16.3-microsoft-standard-WSL2

File hashes

Hashes for myoquant-0.2.0.tar.gz
Algorithm Hash digest
SHA256 59babc1a12fa16024a12bbecb64c58e52ed39f47180a7784c7a5501df4213d2a
MD5 b6a68bc69318b6b1bc2a612334649e6c
BLAKE2b-256 14efffe80f2309b91a13fc9f1cd266ae2dd1e0a8f8981947c334bb1ed122f509

See more details on using hashes here.

File details

Details for the file myoquant-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: myoquant-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 31.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.10.6 Linux/5.10.16.3-microsoft-standard-WSL2

File hashes

Hashes for myoquant-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21822724cd0faa98450c5f6678c772ff03bf8911d3902c3d127239641f89e0ad
MD5 1eb10bb9f9b39bc330e60381a58ea813
BLAKE2b-256 24bab23bc0c4434af0bf852033b0ec17cb6b44519646cd61fc16d947ab9b5f23

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page