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: docs/res/welcome.rst
+22-21Lines changed: 22 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@ Introduction
2
2
===================
3
3
4
4
5
-
Here you will find instructions on how to use the plug-in program.
5
+
Here you will find instructions on how to use the plugin for direct-to-3D segmentation.
6
6
If the installation was successful, you'll see the napari-cellseg3D plugin
7
7
in the Plugins section of napari.
8
8
9
9
This plugin was initially developed for the review of labeled cell volumes [#]_ from mice whole-brain samples
10
10
imaged by mesoSPIM microscopy [#]_ , and for training and using segmentation models from the MONAI project [#]_,
11
-
or any custom model written in Pytorch.
11
+
or any custom model written in PyTorch.
12
12
It should be adaptable to other tasks related to detection of 3D objects, as long as labels are available.
13
13
14
14
@@ -26,32 +26,34 @@ From this page you can access the guides on the several modules available for yo
26
26
* Defining custom models directly in the plugin (WIP) : :ref:`custom_model_guide`
27
27
28
28
29
-
Requirements
29
+
Installation
30
30
--------------------------------------------
31
31
32
-
.. important::
33
-
A **CUDA-capable GPU** is not needed but **very strongly recommended**, especially for training.
34
-
35
-
Requires installation of PyTorch and some optional dependencies of MONAI.
32
+
You can install `napari-cellseg3d` via [pip]:
36
33
37
-
* For PyTorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
34
+
``pip install napari-cellseg3d``
38
35
39
-
* If you get errors from MONAI regarding missing readers, please see `MONAI's optional dependencies`_ page for instructions on getting the readers required by your images.
A **CUDA-capable GPU** is not needed but **very strongly recommended**, especially for training.
48
45
49
-
``pip install napari-cellseg3d``
46
+
This package requires you have napari installed first.
50
47
51
-
For local installation, please run:
48
+
It also depends on PyTorch and some optional dependencies of MONAI. These come in the pip package above, but if
49
+
you need further assistance see below.
52
50
53
-
``pip install -e .``
51
+
* For help with PyTorch, please see `PyTorch's website`_ for installation instructions, with or without CUDA depending on your hardware.
54
52
53
+
* If you get errors from MONAI regarding missing readers, please see `MONAI's optional dependencies`_ page for instructions on getting the readers required by your images.
Then go into Plugins > napari-cellseg3d, and choose which tool to use.
66
+
Then go into Plugins > napari-cellseg3d, and choose which tool to use:
65
67
66
68
67
69
- **Train**: This module allows you to train segmentation algorithms from labeled volumes.
@@ -73,11 +75,11 @@ See above for links to detailed guides regarding the usage of the modules.
73
75
74
76
Acknowledgments & References
75
77
---------------------------------------------
76
-
This plugin has been developed by Cyril Achard and Maxime Vidalfor the `Mathis Laboratory of Adaptive Motor Control`_.
78
+
This plugin has been developed by Cyril Achard and Maxime Vidal, supervised by Mackenzie Mathis for the `Mathis Laboratory of Adaptive Motor Control`_.
77
79
78
80
We also greatly thank Timokleia Kousi for her contributions to this project and the `Wyss Center`_ for project funding.
79
81
80
-
The TRAILMAP models and original weights used here all originate from the `TRAILMAP project on GitHub`_ [1]_.
82
+
The TRAILMAP models and original weights used here were ported to PyTorch but originate from the `TRAILMAP project on GitHub`_ [1]_.
81
83
82
84
This plugin mainly uses the following libraries and software:
83
85
@@ -88,7 +90,7 @@ This plugin mainly uses the following libraries and software:
88
90
* `MONAI project website`_ (various models used here are credited `on their website`_)
89
91
90
92
91
-
.. _Mathis Laboratory of adaptive motor control: http://www.mackenziemathislab.org/
93
+
.. _Mathis Laboratory of Adaptive Motor Control: http://www.mackenziemathislab.org/
92
94
.. _Wyss Center: https://wysscenter.ch/
93
95
.. _TRAILMAP project on GitHub: https://github.com/AlbertPun/TRAILMAP
94
96
.. _napari website: https://napari.org/
@@ -102,4 +104,3 @@ This plugin mainly uses the following libraries and software:
102
104
.. [#] Mapping mesoscale axonal projections in the mouse brain using a 3D convolutional network, Friedmann et al., 2020 ( https://pnas.org/cgi/doi/10.1073/pnas.1918465117 )
103
105
.. [#] The mesoSPIM initiative: open-source light-sheet microscopes for imaging cleared tissue, Voigt et al., 2019 ( https://doi.org/10.1038/s41592-019-0554-0 )
0 commit comments