You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-7Lines changed: 16 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-

1
+

2
2
3
3
# MyoQuant🔬: a tool to automatically quantify pathological features in muscle fiber histology images
4
4
@@ -7,16 +7,17 @@
7
7
</p>
8
8
9
9
MyoQuant🔬 is a command-line tool to automatically quantify pathological features in muscle fiber histology images.
10
-
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.
10
+
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.
11
11
12
-
An online demo with a web interface is available at [https://lbgi.fr/MyoQuant/](https://lbgi.fr/MyoQuant/). This project is free and open-source under the AGPL license, feel free to fork and contribute to the development.
12
+
An online demo with a web interface is available at [https://lbgi.fr/MyoQuant/](https://lbgi.fr/MyoQuant/). This project is free and open-source under the AGPL license, feel free to fork and contribute to the development.
13
13
14
-
#### *Warning: This tool is still in early phases and active development.*
14
+
#### _Warning: This tool is still in early phases and active development._
15
15
16
16
## How to install
17
17
18
18
### Installing from PyPi (Preferred)
19
-
**MyoQuant package is officially available on PyPi (pip) repository. [https://pypi.org/project/myoquant/](https://pypi.org/project/myoquant/)**
19
+
20
+
**MyoQuant package is officially available on PyPi (pip) repository. [https://pypi.org/project/myoquant/](https://pypi.org/project/myoquant/)**
20
21
21
22
Using pip, you can simply install MyoQuant in a python environment with a simple: `pip install myoquant`
22
23
@@ -42,10 +43,12 @@ Then you can perform SDH or HE analysis. You can use the command `myoquant --hel
42
43
_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`_
43
44
44
45
## Contact
45
-
Creator and Maintainer: [**Corentin Meyer**, 3rd year PhD Student in the CSTB Team, ICube — CNRS — Unistra](https://cmeyer.fr) <[email protected]>
46
+
47
+
Creator and Maintainer: [**Corentin Meyer**, 3rd year PhD Student in the CSTB Team, ICube — CNRS — Unistra](https://cmeyer.fr) <[email protected]>
46
48
47
49
## Citing MyoQuant🔬
48
-
[placeholder]
50
+
51
+
[placeholder]
49
52
50
53
## Examples
51
54
@@ -62,9 +65,15 @@ For SDH Staining analysis, you can download this sample image: [HERE](https://ww
62
65
63
66
## Advanced information
64
67
68
+
### Model path and manual download
69
+
65
70
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](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:
In a effort to push for open-science, MyoQuant [SDH dataset](https://huggingface.co/datasets/corentinm7/MyoQuant-SDH-Data) and [model](https://huggingface.co/corentinm7/MyoQuant-SDH-Model) and availiable on HuggingFace🤗
0 commit comments