Skip to main content

Command line interface (CLI) for MyoQuant, my histology image quantification tool.

Project description

MyoQuant

MyoQuant command line tool to quantifying pathological feature in histology images.
It is built using CellPose, Stardist and custom models and image analysis techniques to automatically analyze myopathy histology images. An online demo with a web interface is availiable at https://lbgi.fr/MyoQuant/.

Warning: This tool is still in alpha stage and might not work perfectly... yet.

How to install

Installing from PyPi

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

Installing from source

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

You are ready to go !

How to Use

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

  • 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

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

Who and how

Advanced informations

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

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.1.3.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

myoquant-0.1.3-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: myoquant-0.1.3.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.9.12 Linux/5.4.0-131-generic

File hashes

Hashes for myoquant-0.1.3.tar.gz
Algorithm Hash digest
SHA256 bc53d83cc7adb3b0fdb9a9bdfdad612383cfab3c5b9bf63bebac69610f82beee
MD5 fe16f47ff5d2626c7da665bd0fb425d4
BLAKE2b-256 e98aab875327977626a0817b7a6fd9684fb398aa96a06f24f33d958dbc059690

See more details on using hashes here.

File details

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

File metadata

  • Download URL: myoquant-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 27.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.9.12 Linux/5.4.0-131-generic

File hashes

Hashes for myoquant-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c73b20441f4ff69609b652a2578f7be451abceab4c3a03a966d7be70f413a7f7
MD5 af9cfaea7564d57e6f843de386865305
BLAKE2b-256 08a932a8540dcc67df6800fa0a44007420aec38b0d706568f45c82b70c322fd9

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