diff --git a/README.md b/README.md index 97cebfc..13afd7f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# napari-sp8-tracking +# napari-trackpy -[![License MIT](https://img.shields.io/pypi/l/napari-sp8-tracking.svg?color=green)](https://github.com/rhoitink/napari-sp8-tracking/raw/main/LICENSE) -[![PyPI](https://img.shields.io/pypi/v/napari-sp8-tracking.svg?color=green)](https://pypi.org/project/napari-sp8-tracking) -[![Python Version](https://img.shields.io/pypi/pyversions/napari-sp8-tracking.svg?color=green)](https://python.org) -[![tests](https://github.com/rhoitink/napari-sp8-tracking/workflows/tests/badge.svg)](https://github.com/rhoitink/napari-sp8-tracking/actions) -[![codecov](https://codecov.io/gh/rhoitink/napari-sp8-tracking/branch/main/graph/badge.svg)](https://codecov.io/gh/rhoitink/napari-sp8-tracking) -[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-sp8-tracking)](https://napari-hub.org/plugins/napari-sp8-tracking) +[![License MIT](https://img.shields.io/pypi/l/napari-trackpy.svg?color=green)](https://github.com/rhoitink/napari-trackpy/raw/main/LICENSE) +[![PyPI](https://img.shields.io/pypi/v/napari-trackpy.svg?color=green)](https://pypi.org/project/napari-trackpy) +[![Python Version](https://img.shields.io/pypi/pyversions/napari-trackpy.svg?color=green)](https://python.org) +[![tests](https://github.com/rhoitink/napari-trackpy/workflows/tests/badge.svg)](https://github.com/rhoitink/napari-trackpy/actions) +[![codecov](https://codecov.io/gh/rhoitink/napari-trackpy/branch/main/graph/badge.svg)](https://codecov.io/gh/rhoitink/napari-trackpy) +[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-trackpy)](https://napari-hub.org/plugins/napari-trackpy) -Plugin to do trackpy particle tracking on SP8 confocal data within napari +Plugin to do trackpy particle tracking on 3D microscopy data within napari ---------------------------------- @@ -23,15 +23,15 @@ https://napari.org/stable/plugins/index.html ## Installation -You can install `napari-sp8-tracking` via [pip]: +You can install `napari-trackpy` via [pip]: - pip install napari-sp8-tracking + pip install napari-trackpy To install latest development version : - pip install git+https://github.com/rhoitink/napari-sp8-tracking.git + pip install git+https://github.com/rhoitink/napari-trackpy.git ## Contributing @@ -42,7 +42,7 @@ the coverage at least stays the same before you submit a pull request. ## License Distributed under the terms of the [MIT] license, -"napari-sp8-tracking" is free and open source software +"napari-trackpy" is free and open source software ## Issues @@ -59,7 +59,7 @@ If you encounter any problems, please [file an issue] along with a detailed desc [Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt [cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin -[file an issue]: https://github.com/rhoitink/napari-sp8-tracking/issues +[file an issue]: https://github.com/rhoitink/napari-trackpy/issues [napari]: https://github.com/napari/napari [tox]: https://tox.readthedocs.io/en/latest/ diff --git a/pyproject.toml b/pyproject.toml index e2b17e4..4cfbdc9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [tool.setuptools_scm] -write_to = "src/napari_sp8_tracking/_version.py" +write_to = "src/napari_trackpy/_version.py" [tool.black] line-length = 79 diff --git a/setup.cfg b/setup.cfg index 2026085..269ada7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,10 +1,10 @@ [metadata] -name = napari-sp8-tracking +name = napari-trackpy -description = Plugin to do trackpy particle tracking on SP8 confocal data within napari +description = Plugin to do trackpy particle tracking on microscopy data within napari long_description = file: README.md long_description_content_type = text/markdown -url = https://github.com/rhoitink/napari-sp8-tracking +url = https://github.com/rhoitink/napari-trackpy author = Roy Hoitink author_email = L.D.Hoitink@uu.nl license = MIT @@ -23,10 +23,10 @@ classifiers = Programming Language :: Python :: 3.10 Topic :: Scientific/Engineering :: Image Processing project_urls = - Bug Tracker = https://github.com/rhoitink/napari-sp8-tracking/issues - Documentation = https://github.com/rhoitink/napari-sp8-tracking#README.md - Source Code = https://github.com/rhoitink/napari-sp8-tracking - User Support = https://github.com/rhoitink/napari-sp8-tracking/issues + Bug Tracker = https://github.com/rhoitink/napari-trackpy/issues + Documentation = https://github.com/rhoitink/napari-trackpy#README.md + Source Code = https://github.com/rhoitink/napari-trackpy + User Support = https://github.com/rhoitink/napari-trackpy/issues [options] packages = find: @@ -51,7 +51,7 @@ where = src [options.entry_points] napari.manifest = - napari-sp8-tracking = napari_sp8_tracking:napari.yaml + napari-trackpy = napari_trackpy:napari.yaml [options.extras_require] testing = diff --git a/src/napari_sp8_tracking/__init__.py b/src/napari_sp8_tracking/__init__.py deleted file mode 100644 index 30a954b..0000000 --- a/src/napari_sp8_tracking/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -try: - from ._version import version as __version__ -except ImportError: - __version__ = "unknown" - -__all__ = "particle_tracking_settings_widget" diff --git a/src/napari_sp8_tracking/napari.yaml b/src/napari_sp8_tracking/napari.yaml deleted file mode 100644 index 07b017c..0000000 --- a/src/napari_sp8_tracking/napari.yaml +++ /dev/null @@ -1,10 +0,0 @@ -name: napari-sp8-tracking -display_name: Particle tracking -contributions: - commands: - - id: napari-sp8-tracking.particle_tracking_settings_widget - python_name: napari_sp8_tracking._widget:particle_tracking_settings_widget - title: Trackpy particle tracking - widgets: - - command: napari-sp8-tracking.particle_tracking_settings_widget - display_name: Trackpy particle tracking diff --git a/src/napari_trackpy/__init__.py b/src/napari_trackpy/__init__.py new file mode 100644 index 0000000..8905242 --- /dev/null +++ b/src/napari_trackpy/__init__.py @@ -0,0 +1,9 @@ +try: + from ._version import version as __version__ +except ImportError: + __version__ = "unknown" +from ._widget import xyz_particle_tracking_settings_widget + +__all__ = [ + "xyz_particle_tracking_settings_widget", +] diff --git a/src/napari_sp8_tracking/_tests/__init__.py b/src/napari_trackpy/_tests/__init__.py similarity index 100% rename from src/napari_sp8_tracking/_tests/__init__.py rename to src/napari_trackpy/_tests/__init__.py diff --git a/src/napari_sp8_tracking/_tests/test_placeholder.py b/src/napari_trackpy/_tests/test_placeholder.py similarity index 100% rename from src/napari_sp8_tracking/_tests/test_placeholder.py rename to src/napari_trackpy/_tests/test_placeholder.py diff --git a/src/napari_sp8_tracking/_widget.py b/src/napari_trackpy/_widget.py similarity index 97% rename from src/napari_sp8_tracking/_widget.py rename to src/napari_trackpy/_widget.py index 19527a2..02acf59 100644 --- a/src/napari_sp8_tracking/_widget.py +++ b/src/napari_trackpy/_widget.py @@ -28,7 +28,7 @@ @magic_factory( min_mass={"widget_type": "SpinBox", "max": int(1e8)}, ) -def particle_tracking_settings_widget( +def xyz_particle_tracking_settings_widget( viewer: "napari.viewer.Viewer", img_layer: "napari.layers.Image", feature_size_xy_µm: float = 0.3, @@ -51,7 +51,7 @@ def particle_tracking_settings_widget( global fig_added, fig, ax if not fig_added: fig, ax = plt.subplots(1, 1) - particle_tracking_settings_widget.native.layout().addWidget( + xyz_particle_tracking_settings_widget.native.layout().addWidget( FigureCanvas(fig) ) fig_added = True diff --git a/src/napari_trackpy/napari.yaml b/src/napari_trackpy/napari.yaml new file mode 100644 index 0000000..2189ba4 --- /dev/null +++ b/src/napari_trackpy/napari.yaml @@ -0,0 +1,10 @@ +name: napari-trackpy +display_name: Particle tracking +contributions: + commands: + - id: napari-trackpy.xyz_particle_tracking_settings_widget + python_name: napari_trackpy:xyz_particle_tracking_settings_widget + title: XYZ particle tracking + widgets: + - command: napari-trackpy.xyz_particle_tracking_settings_widget + display_name: XYZ particle tracking diff --git a/tox.ini b/tox.ini index 461efa6..76bf75e 100644 --- a/tox.ini +++ b/tox.ini @@ -29,4 +29,4 @@ passenv = PYVISTA_OFF_SCREEN extras = testing -commands = pytest -v --color=yes --cov=napari_sp8_tracking --cov-report=xml +commands = pytest -v --color=yes --cov=napari_trackpy --cov-report=xml