napari-spatial-correlation-plotter 0.0.3__tar.gz → 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/LICENSE +0 -0
  2. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/MANIFEST.in +0 -0
  3. {napari_spatial_correlation_plotter-0.0.3/src/napari_spatial_correlation_plotter.egg-info → napari_spatial_correlation_plotter-1.0.0}/PKG-INFO +29 -18
  4. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/README.md +26 -9
  5. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/pyproject.toml +0 -0
  6. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/setup.cfg +0 -9
  7. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter/__init__.py +1 -1
  8. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter/_nice_colormap.py +0 -0
  9. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter/_widget.py +4 -0
  10. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter/napari.yaml +0 -0
  11. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0/src/napari_spatial_correlation_plotter.egg-info}/PKG-INFO +29 -18
  12. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter.egg-info/SOURCES.txt +1 -2
  13. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter.egg-info/dependency_links.txt +0 -0
  14. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter.egg-info/entry_points.txt +0 -0
  15. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter.egg-info/requires.txt +0 -8
  16. {napari_spatial_correlation_plotter-0.0.3 → napari_spatial_correlation_plotter-1.0.0}/src/napari_spatial_correlation_plotter.egg-info/top_level.txt +0 -0
  17. napari_spatial_correlation_plotter-0.0.3/src/napari_spatial_correlation_plotter/_tests/__init__.py +0 -0
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: napari-spatial-correlation-plotter
3
- Version: 0.0.3
3
+ Version: 1.0.0
4
4
  Summary: A plugin to compute and display spatial correlation histograms in Napari
5
5
  Home-page: https://github.com/jules-vanaret/napari-spatial-correlation-plotter
6
6
  Author: Jules Vanaret
@@ -32,24 +32,16 @@ Requires-Dist: scikit-image
32
32
  Requires-Dist: qtpy
33
33
  Requires-Dist: pyclesperanto_prototype
34
34
  Requires-Dist: tapenade
35
- Provides-Extra: testing
36
- Requires-Dist: tox; extra == "testing"
37
- Requires-Dist: pytest; extra == "testing"
38
- Requires-Dist: pytest-cov; extra == "testing"
39
- Requires-Dist: pytest-qt; extra == "testing"
40
- Requires-Dist: napari; extra == "testing"
41
- Requires-Dist: pyqt5; extra == "testing"
35
+ Dynamic: license-file
42
36
 
43
37
  # :herb: napari-spatial-correlation-plotter
44
38
 
45
39
  [![License MIT](https://img.shields.io/pypi/l/napari-spatial-correlation-plotter.svg?color=green)](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/raw/main/LICENSE)
46
40
  [![PyPI](https://img.shields.io/pypi/v/napari-spatial-correlation-plotter.svg?color=green)](https://pypi.org/project/napari-spatial-correlation-plotter)
47
41
  [![Python Version](https://img.shields.io/pypi/pyversions/napari-spatial-correlation-plotter.svg?color=green)](https://python.org)
48
- [![tests](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/workflows/tests/badge.svg)](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/actions)
49
- [![codecov](https://codecov.io/gh/jules-vanaret/napari-spatial-correlation-plotter/branch/main/graph/badge.svg)](https://codecov.io/gh/jules-vanaret/napari-spatial-correlation-plotter)
50
42
  [![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-spatial-correlation-plotter)](https://napari-hub.org/plugins/napari-spatial-correlation-plotter)
51
43
 
52
- <img src="https://github.com/GuignardLab/tapenade/blob/Packaging/imgs/tapenade3.png" width="100">
44
+ <img src="https://github.com/GuignardLab/tapenade/blob/main/imgs/tapenade3.png" width="100">
53
45
 
54
46
  A plugin to dynamically interact with the spatial correlation heatmap obtained by comparing two continuous fields of biophysical properties in 3D tissues.
55
47
 
@@ -59,6 +51,8 @@ If you use this plugin for your research, please [cite us](https://github.com/Gu
59
51
 
60
52
  ## Overview
61
53
 
54
+ <img src="imgs/napari_correlation_demo.gif">
55
+
62
56
  While working with large and dense 3D and 3D+time gastruloid datasets, we found that being able to visualise and interact with the data dynamically greatly helped processing it.
63
57
  During the pre-processing stage, dynamical exploration and interaction led to faster tuning of the parameters by allowing direct visual feedback, and gave key biophysical insight during the analysis stage.
64
58
 
@@ -105,6 +99,29 @@ Steps:
105
99
  13. To trigger the grid view like in the example image, you can click on the `Toggle grid mode` button. This will display all layers in a grid view. By right clicking the button, you can parametrize the grid view (e.g number of columns, number of rows, etc).
106
100
  14. You can switch between 2D and 3D view at all time by clicking on the `Toggle 2D/3D view` button (it resembles a square when in 2D mode, or a cube when in 3D mode).
107
101
 
102
+ ## Demo dataset
103
+
104
+ A demo dataset is available [here](https://amubox.univ-amu.fr/s/igYycspAiXankWF).
105
+
106
+ ### Content
107
+
108
+ This test dataset is composed of five 3D images.
109
+ - `bra isotropized.tif`, `dapi isotropized.tif`, and `ecad isotropized.tif` correspond to 3 biological signals images, respectively Brachyury, Dapi, and E-Cadherin.
110
+ - `mask.tif` is a binary mask that defines the inside/outside of the sample.
111
+ - `labels.tif` is the nuclei segmentation performed on the Dapi channel with our custom Stardist3D model.
112
+
113
+ ### How to use
114
+
115
+ - Load the images from the folder (either drag and drop, or "File>Open file(s)").
116
+ - Follow instructions from the plugin repository to test the plugin.
117
+
118
+ ## How to cite
119
+
120
+ If you use this plugin for your research, please cite us using the following reference:
121
+
122
+ - Jules Vanaret, Alice Gros, Valentin Dunsing-Eichenauer, Agathe Rostan, Philippe Roudot, Pierre-François Lenne, Léo Guignard, Sham Tlili (2025) <b>A quantitative pipeline for whole-mount deep imaging and analysis of multi-layered organoids across scales</b>. eLife 14:RP107154 ; doi:https://doi.org/10.7554/eLife.107154.2
123
+
124
+
108
125
  ## Acknowledgements
109
126
 
110
127
  The "napari-clusters-plotter" plugin [1] heavily inspired this plugin, most notably the `SelectFromCollection`, `MplCanvas` and `FigureToolbar` classes. The `PlotterWidget` class has been modified for the specific use case of this plugin, but the core functionalites have been adapted directly.
@@ -113,11 +130,6 @@ napari-clusters-plotter source code is available [here](https://github.com/BiAPo
113
130
 
114
131
  [1] Zigutyte, L., Savill, R., Müller, J., Zoccoler, M., Wagner, T., & Haase, R. (2023). napari-clusters-plotter. Zenodo. https://doi.org/10.5281/zenodo.5884657
115
132
 
116
- ## Contributing
117
-
118
- Contributions are very welcome. Tests can be run with [tox], please ensure
119
- the coverage at least stays the same before you submit a pull request.
120
-
121
133
  ## License
122
134
 
123
135
  Distributed under the terms of the [MIT] license,
@@ -145,6 +157,5 @@ This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookie
145
157
  [file an issue]: https://github.com/jules-vanaret/napari-spatial-correlation-plotter/issues
146
158
 
147
159
  [napari]: https://github.com/napari/napari
148
- [tox]: https://tox.readthedocs.io/en/latest/
149
160
  [pip]: https://pypi.org/project/pip/
150
161
  [PyPI]: https://pypi.org/
@@ -3,11 +3,9 @@
3
3
  [![License MIT](https://img.shields.io/pypi/l/napari-spatial-correlation-plotter.svg?color=green)](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/raw/main/LICENSE)
4
4
  [![PyPI](https://img.shields.io/pypi/v/napari-spatial-correlation-plotter.svg?color=green)](https://pypi.org/project/napari-spatial-correlation-plotter)
5
5
  [![Python Version](https://img.shields.io/pypi/pyversions/napari-spatial-correlation-plotter.svg?color=green)](https://python.org)
6
- [![tests](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/workflows/tests/badge.svg)](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/actions)
7
- [![codecov](https://codecov.io/gh/jules-vanaret/napari-spatial-correlation-plotter/branch/main/graph/badge.svg)](https://codecov.io/gh/jules-vanaret/napari-spatial-correlation-plotter)
8
6
  [![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-spatial-correlation-plotter)](https://napari-hub.org/plugins/napari-spatial-correlation-plotter)
9
7
 
10
- <img src="https://github.com/GuignardLab/tapenade/blob/Packaging/imgs/tapenade3.png" width="100">
8
+ <img src="https://github.com/GuignardLab/tapenade/blob/main/imgs/tapenade3.png" width="100">
11
9
 
12
10
  A plugin to dynamically interact with the spatial correlation heatmap obtained by comparing two continuous fields of biophysical properties in 3D tissues.
13
11
 
@@ -17,6 +15,8 @@ If you use this plugin for your research, please [cite us](https://github.com/Gu
17
15
 
18
16
  ## Overview
19
17
 
18
+ <img src="imgs/napari_correlation_demo.gif">
19
+
20
20
  While working with large and dense 3D and 3D+time gastruloid datasets, we found that being able to visualise and interact with the data dynamically greatly helped processing it.
21
21
  During the pre-processing stage, dynamical exploration and interaction led to faster tuning of the parameters by allowing direct visual feedback, and gave key biophysical insight during the analysis stage.
22
22
 
@@ -63,6 +63,29 @@ Steps:
63
63
  13. To trigger the grid view like in the example image, you can click on the `Toggle grid mode` button. This will display all layers in a grid view. By right clicking the button, you can parametrize the grid view (e.g number of columns, number of rows, etc).
64
64
  14. You can switch between 2D and 3D view at all time by clicking on the `Toggle 2D/3D view` button (it resembles a square when in 2D mode, or a cube when in 3D mode).
65
65
 
66
+ ## Demo dataset
67
+
68
+ A demo dataset is available [here](https://amubox.univ-amu.fr/s/igYycspAiXankWF).
69
+
70
+ ### Content
71
+
72
+ This test dataset is composed of five 3D images.
73
+ - `bra isotropized.tif`, `dapi isotropized.tif`, and `ecad isotropized.tif` correspond to 3 biological signals images, respectively Brachyury, Dapi, and E-Cadherin.
74
+ - `mask.tif` is a binary mask that defines the inside/outside of the sample.
75
+ - `labels.tif` is the nuclei segmentation performed on the Dapi channel with our custom Stardist3D model.
76
+
77
+ ### How to use
78
+
79
+ - Load the images from the folder (either drag and drop, or "File>Open file(s)").
80
+ - Follow instructions from the plugin repository to test the plugin.
81
+
82
+ ## How to cite
83
+
84
+ If you use this plugin for your research, please cite us using the following reference:
85
+
86
+ - Jules Vanaret, Alice Gros, Valentin Dunsing-Eichenauer, Agathe Rostan, Philippe Roudot, Pierre-François Lenne, Léo Guignard, Sham Tlili (2025) <b>A quantitative pipeline for whole-mount deep imaging and analysis of multi-layered organoids across scales</b>. eLife 14:RP107154 ; doi:https://doi.org/10.7554/eLife.107154.2
87
+
88
+
66
89
  ## Acknowledgements
67
90
 
68
91
  The "napari-clusters-plotter" plugin [1] heavily inspired this plugin, most notably the `SelectFromCollection`, `MplCanvas` and `FigureToolbar` classes. The `PlotterWidget` class has been modified for the specific use case of this plugin, but the core functionalites have been adapted directly.
@@ -71,11 +94,6 @@ napari-clusters-plotter source code is available [here](https://github.com/BiAPo
71
94
 
72
95
  [1] Zigutyte, L., Savill, R., Müller, J., Zoccoler, M., Wagner, T., & Haase, R. (2023). napari-clusters-plotter. Zenodo. https://doi.org/10.5281/zenodo.5884657
73
96
 
74
- ## Contributing
75
-
76
- Contributions are very welcome. Tests can be run with [tox], please ensure
77
- the coverage at least stays the same before you submit a pull request.
78
-
79
97
  ## License
80
98
 
81
99
  Distributed under the terms of the [MIT] license,
@@ -103,6 +121,5 @@ This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookie
103
121
  [file an issue]: https://github.com/jules-vanaret/napari-spatial-correlation-plotter/issues
104
122
 
105
123
  [napari]: https://github.com/napari/napari
106
- [tox]: https://tox.readthedocs.io/en/latest/
107
124
  [pip]: https://pypi.org/project/pip/
108
125
  [PyPI]: https://pypi.org/
@@ -50,15 +50,6 @@ where = src
50
50
  napari.manifest =
51
51
  napari-spatial-correlation-plotter = napari_spatial_correlation_plotter:napari.yaml
52
52
 
53
- [options.extras_require]
54
- testing =
55
- tox
56
- pytest # https://docs.pytest.org/en/latest/contents.html
57
- pytest-cov # https://pytest-cov.readthedocs.io/en/latest/
58
- pytest-qt # https://pytest-qt.readthedocs.io/en/latest/
59
- napari
60
- pyqt5
61
-
62
53
  [options.package_data]
63
54
  * = *.yaml
64
55
 
@@ -1,4 +1,4 @@
1
- __version__ = "0.0.3"
1
+ __version__ = "1.0.0"
2
2
  from ._widget import PlotterWidget
3
3
 
4
4
  __all__ = (
@@ -1,4 +1,8 @@
1
1
  """
2
+ Copyright (c) 2024 Jules Vanaret
3
+
4
+ The SelectFromCollection, MplCanvas, FigureToolbar classes, and parts of
5
+ the PlotterWidget class are licensed under
2
6
  Copyright (c) 2022, DFG Cluster of Excellence "Physics of Life" TU Dresden: Robert Haase, Laura Zigutyte, Marcello Zoccoler, Ryan Savill, Johannes Müller and Max Planck Institute of Molecular Physiology Dortmund: Thorsten Wagner
3
7
  """
4
8
  import os
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: napari-spatial-correlation-plotter
3
- Version: 0.0.3
3
+ Version: 1.0.0
4
4
  Summary: A plugin to compute and display spatial correlation histograms in Napari
5
5
  Home-page: https://github.com/jules-vanaret/napari-spatial-correlation-plotter
6
6
  Author: Jules Vanaret
@@ -32,24 +32,16 @@ Requires-Dist: scikit-image
32
32
  Requires-Dist: qtpy
33
33
  Requires-Dist: pyclesperanto_prototype
34
34
  Requires-Dist: tapenade
35
- Provides-Extra: testing
36
- Requires-Dist: tox; extra == "testing"
37
- Requires-Dist: pytest; extra == "testing"
38
- Requires-Dist: pytest-cov; extra == "testing"
39
- Requires-Dist: pytest-qt; extra == "testing"
40
- Requires-Dist: napari; extra == "testing"
41
- Requires-Dist: pyqt5; extra == "testing"
35
+ Dynamic: license-file
42
36
 
43
37
  # :herb: napari-spatial-correlation-plotter
44
38
 
45
39
  [![License MIT](https://img.shields.io/pypi/l/napari-spatial-correlation-plotter.svg?color=green)](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/raw/main/LICENSE)
46
40
  [![PyPI](https://img.shields.io/pypi/v/napari-spatial-correlation-plotter.svg?color=green)](https://pypi.org/project/napari-spatial-correlation-plotter)
47
41
  [![Python Version](https://img.shields.io/pypi/pyversions/napari-spatial-correlation-plotter.svg?color=green)](https://python.org)
48
- [![tests](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/workflows/tests/badge.svg)](https://github.com/jules-vanaret/napari-spatial-correlation-plotter/actions)
49
- [![codecov](https://codecov.io/gh/jules-vanaret/napari-spatial-correlation-plotter/branch/main/graph/badge.svg)](https://codecov.io/gh/jules-vanaret/napari-spatial-correlation-plotter)
50
42
  [![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-spatial-correlation-plotter)](https://napari-hub.org/plugins/napari-spatial-correlation-plotter)
51
43
 
52
- <img src="https://github.com/GuignardLab/tapenade/blob/Packaging/imgs/tapenade3.png" width="100">
44
+ <img src="https://github.com/GuignardLab/tapenade/blob/main/imgs/tapenade3.png" width="100">
53
45
 
54
46
  A plugin to dynamically interact with the spatial correlation heatmap obtained by comparing two continuous fields of biophysical properties in 3D tissues.
55
47
 
@@ -59,6 +51,8 @@ If you use this plugin for your research, please [cite us](https://github.com/Gu
59
51
 
60
52
  ## Overview
61
53
 
54
+ <img src="imgs/napari_correlation_demo.gif">
55
+
62
56
  While working with large and dense 3D and 3D+time gastruloid datasets, we found that being able to visualise and interact with the data dynamically greatly helped processing it.
63
57
  During the pre-processing stage, dynamical exploration and interaction led to faster tuning of the parameters by allowing direct visual feedback, and gave key biophysical insight during the analysis stage.
64
58
 
@@ -105,6 +99,29 @@ Steps:
105
99
  13. To trigger the grid view like in the example image, you can click on the `Toggle grid mode` button. This will display all layers in a grid view. By right clicking the button, you can parametrize the grid view (e.g number of columns, number of rows, etc).
106
100
  14. You can switch between 2D and 3D view at all time by clicking on the `Toggle 2D/3D view` button (it resembles a square when in 2D mode, or a cube when in 3D mode).
107
101
 
102
+ ## Demo dataset
103
+
104
+ A demo dataset is available [here](https://amubox.univ-amu.fr/s/igYycspAiXankWF).
105
+
106
+ ### Content
107
+
108
+ This test dataset is composed of five 3D images.
109
+ - `bra isotropized.tif`, `dapi isotropized.tif`, and `ecad isotropized.tif` correspond to 3 biological signals images, respectively Brachyury, Dapi, and E-Cadherin.
110
+ - `mask.tif` is a binary mask that defines the inside/outside of the sample.
111
+ - `labels.tif` is the nuclei segmentation performed on the Dapi channel with our custom Stardist3D model.
112
+
113
+ ### How to use
114
+
115
+ - Load the images from the folder (either drag and drop, or "File>Open file(s)").
116
+ - Follow instructions from the plugin repository to test the plugin.
117
+
118
+ ## How to cite
119
+
120
+ If you use this plugin for your research, please cite us using the following reference:
121
+
122
+ - Jules Vanaret, Alice Gros, Valentin Dunsing-Eichenauer, Agathe Rostan, Philippe Roudot, Pierre-François Lenne, Léo Guignard, Sham Tlili (2025) <b>A quantitative pipeline for whole-mount deep imaging and analysis of multi-layered organoids across scales</b>. eLife 14:RP107154 ; doi:https://doi.org/10.7554/eLife.107154.2
123
+
124
+
108
125
  ## Acknowledgements
109
126
 
110
127
  The "napari-clusters-plotter" plugin [1] heavily inspired this plugin, most notably the `SelectFromCollection`, `MplCanvas` and `FigureToolbar` classes. The `PlotterWidget` class has been modified for the specific use case of this plugin, but the core functionalites have been adapted directly.
@@ -113,11 +130,6 @@ napari-clusters-plotter source code is available [here](https://github.com/BiAPo
113
130
 
114
131
  [1] Zigutyte, L., Savill, R., Müller, J., Zoccoler, M., Wagner, T., & Haase, R. (2023). napari-clusters-plotter. Zenodo. https://doi.org/10.5281/zenodo.5884657
115
132
 
116
- ## Contributing
117
-
118
- Contributions are very welcome. Tests can be run with [tox], please ensure
119
- the coverage at least stays the same before you submit a pull request.
120
-
121
133
  ## License
122
134
 
123
135
  Distributed under the terms of the [MIT] license,
@@ -145,6 +157,5 @@ This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookie
145
157
  [file an issue]: https://github.com/jules-vanaret/napari-spatial-correlation-plotter/issues
146
158
 
147
159
  [napari]: https://github.com/napari/napari
148
- [tox]: https://tox.readthedocs.io/en/latest/
149
160
  [pip]: https://pypi.org/project/pip/
150
161
  [PyPI]: https://pypi.org/
@@ -12,5 +12,4 @@ src/napari_spatial_correlation_plotter.egg-info/SOURCES.txt
12
12
  src/napari_spatial_correlation_plotter.egg-info/dependency_links.txt
13
13
  src/napari_spatial_correlation_plotter.egg-info/entry_points.txt
14
14
  src/napari_spatial_correlation_plotter.egg-info/requires.txt
15
- src/napari_spatial_correlation_plotter.egg-info/top_level.txt
16
- src/napari_spatial_correlation_plotter/_tests/__init__.py
15
+ src/napari_spatial_correlation_plotter.egg-info/top_level.txt
@@ -5,11 +5,3 @@ scikit-image
5
5
  qtpy
6
6
  pyclesperanto_prototype
7
7
  tapenade
8
-
9
- [testing]
10
- tox
11
- pytest
12
- pytest-cov
13
- pytest-qt
14
- napari
15
- pyqt5