Skip to content

Commit a985102

Browse files
authored
Update README.md (#3)
1 parent 5abf6d9 commit a985102

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,36 @@
1-
# napari-cellseg3d: a napari plug-in for 3d deep learning models for cell segmentation
1+
# napari-cellseg3D: a napari plug-in for direct 3D cell segmentation with deep learning
22

33

4-
<img src="docs/res/logo/logo_background.png" title="cellseg3d" alt="cellseg3d logo" width="250" align="right" vspace = "80"/>
4+
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/04991e21-9cee-4b21-bdfc-d465fd73247d/CELLSEGGIT.png?format=2500w" title="cellseg3d" alt="cellseg3d logo" width="250" align="right" vspace = "80"/>
55

66
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
77
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/AdaptiveMotorControlLab/CellSeg3d/raw/main/LICENSE)
88
[![PyPI](https://img.shields.io/pypi/v/napari-cellseg-annotator.svg?color=green)](https://pypi.org/project/napari-cellseg-annotator)
99
[![Python Version](https://img.shields.io/pypi/pyversions/napari-cellseg-annotator.svg?color=green)](https://python.org)
10-
[![tests](https://github.com/AdaptiveMotorControlLab/CellSeg3d/workflows/tests/badge.svg)](https://github.com/AdaptiveMotorControlLab/CellSeg3d/actions)
10+
![Testing](https://github.com/AdaptiveMotorControlLab/CellSeg3d/workflows/Python%20package/badge.svg)
1111
[![codecov](https://codecov.io/gh/AdaptiveMotorControlLab/napari-cellseg3d/branch/main/graph/badge.svg)](https://codecov.io/gh/AdaptiveMotorControlLab/CellSeg3d)
1212
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-cellseg3d)](https://napari-hub.org/plugins/CellSeg3d)
1313

1414

1515
A napari plugin for 3D cell segmentation: training, inference, and data review. In particular, this project was developed for analysis of mesoSPIM-acquired (cleared tissue + lightsheet) datasets.
1616

17-
**Pre-Alpha version, please expect bugs and issues. Reporting them on the Github repository would help us a lot!**
18-
1917
----------------------------------
2018

19+
## News
20+
21+
**June 2022: This is an alpha version, please expect bugs and issues, and help us make the code better by reporting them as an issue!**
22+
23+
24+
2125
## Installation
2226

23-
You can install `napari-cellseg-3d` via [pip] (pypi-test placeholder):
27+
You can install `napari-cellseg3d` via [pip] (pypi-test placeholder):
2428

2529
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ napari-cellseg3d==0.0.3
2630

2731
## Documentation
2832

29-
Available on the [Github pages website](https://adaptivemotorcontrollab.github.io/cellseg3d-docs/)
30-
31-
Source files can be found at https://AdaptiveMotorControlLab.github.io/cellseg3d-docs
33+
Available at https://AdaptiveMotorControlLab.github.io/cellseg3d-docs
3234

3335
You can also generate docs by running ``make html`` in the docs folder.
3436

@@ -38,7 +40,7 @@ To use the plugin, please run:
3840
```
3941
napari
4042
```
41-
Then go into Plugins > napari-cellseg-3d, and choose which tool to use.
43+
Then go into Plugins > napari-cellseg3d, and choose which tool to use.
4244

4345
- **Review**: This module allows you to review your labels, from predictions or manual labeling, and correct them if needed. It then saves the status of each file in a csv, for easier monitoring.
4446
- **Inference**: This module allows you to use pre-trained segmentation algorithms on volumes to automatically label cells and compute statistics.
@@ -51,7 +53,7 @@ Then go into Plugins > napari-cellseg-3d, and choose which tool to use.
5153

5254
Requires manual installation of **pytorch** and **MONAI**.
5355

54-
For Pytorch, please see [PyTorch's website for installation instructions].
56+
For PyTorch, please see [PyTorch's website for installation instructions].
5557
A CUDA-capable GPU is not needed but very strongly recommended, especially for training.
5658

5759
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.
@@ -86,7 +88,7 @@ pip install -e .
8688

8789
Distributed under the terms of the [MIT] license.
8890

89-
"napari-cellseg-3d" is free and open source software.
91+
"napari-cellseg3d" is free and open source software.
9092

9193

9294
[file an issue]: https://github.com/AdaptiveMotorControlLab/CellSeg3d/issues
@@ -113,7 +115,7 @@ Distributed under the terms of the [MIT] license.
113115

114116
This plugin was developed by Cyril Achard & Maxime Vidal.
115117

116-
This work was funded, in part, from the Wyss Center to the Adaptive Motor Control Lab.
118+
This work was funded, in part, from the Wyss Center to the [Mathis Laboratory of Adaptive Motor Control](https://www.mackenziemathislab.org/).
117119

118120

119121
## Plugin base

0 commit comments

Comments
 (0)