Skip to content

Commit

Permalink
v0.0.1rc1
Browse files Browse the repository at this point in the history
  • Loading branch information
MMathisLab committed Jun 25, 2022
1 parent b89a54b commit c64f118
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ A napari plugin for 3D cell segmentation: training, inference, and data review.

## News

**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!**
**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!**



## Installation

You can install `napari-cellseg3d` via [pip] (pypi-test placeholder):
You can install `napari-cellseg3d` via [pip]:

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

## Documentation

Expand All @@ -44,7 +44,7 @@ Then go into Plugins > napari-cellseg3d, and choose which tool to use.
- **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.
- **Inference**: This module allows you to use pre-trained segmentation algorithms on volumes to automatically label cells and compute statistics.
- **Train**: This module allows you to train segmentation algorithms from labeled volumes.
- **Utilities**: This module allows you to perform several actions like cropping your volumes and labels dynamically, by selecting a fixed size volume and moving it around the image; computing prediction scores from ground truth and predicition labels; or converting labels from instance to segmentation and the opposite.
- **Utilities**: This module allows you to perform several actions like cropping your volumes and labels dynamically, by selecting a fixed size volume and moving it around the image; computing prediction scores from ground truth and predicition labels; or converting labels from instance to segmentation and the opposite.


## Requirements
Expand All @@ -61,17 +61,17 @@ If you get errors from MONAI regarding missing readers, please see [MONAI's opti
If you encounter any problems, please [file an issue] along with a detailed description.


## Testing
## Testing

To run tests locally:
To run tests locally:

- Locally : run ``pytest`` in the plugin folder
- Locally with coverage : In the plugin folder, run ``coverage run --source=src -m pytest`` then ``coverage.xml`` to generate a .xml coverage file.
- With tox : run ``tox`` in the plugin folder (will simulate tests with several python and OS configs, requires substantial storage space)

## Contributing

Contributions are very welcome.
Contributions are very welcome.

Please ensure the coverage at least stays the same before you submit a pull request.

Expand Down Expand Up @@ -108,7 +108,7 @@ Distributed under the terms of the [MIT] license.
[PyTorch's website for installation instructions]: https://pytorch.org/get-started/locally/
[MONAI's optional dependencies]: https://docs.monai.io/en/stable/installation.html#installing-the-recommended-dependencies

## Acknowledgements
## Acknowledgements

This plugin was developed by Cyril Achard, Maxime Vidal, Mackenzie Mathis. This work was funded, in part, from the Wyss Center to the [Mathis Laboratory of Adaptive Motor Control](https://www.mackenziemathislab.org/).

Expand Down
2 changes: 1 addition & 1 deletion napari_cellseg3d/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.0.3"
__version__ = "0.0.1rc1"
2 changes: 1 addition & 1 deletion napari_cellseg3d/plugin_helper.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def __init__(self, viewer: "napari.viewer.Viewer"):
self.logo_label.setToolTip("Open Github page")

self.info_label = ui.make_label(
f"You are using napari-cellseg3d v.{'0.0.3'}\n\n"
f"You are using napari-cellseg3d v.{'0.0.1rc1'}\n\n"
f"Plugin for cell segmentation developed\n"
f"by the Mathis Lab of Adaptive Motor Control\n\n"
f"Code by Cyril Achard and Maxime Vidal and Mackenzie Mathis\n"
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = napari-cellseg3d
version = 0.0.3
version = 0.0.1rc1
author = Cyril Achard, Maxime Vidal, Mackenzie Mathis
author_email = [email protected], [email protected], [email protected]

Expand Down

0 comments on commit c64f118

Please sign in to comment.