napari-trackpy


Namenapari-trackpy JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://github.com/rhoitink/napari-trackpy
SummaryPlugin to do trackpy particle tracking on microscopy data within napari
upload_time2023-11-09 09:29:04
maintainer
docs_urlNone
authorRoy Hoitink
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # napari-trackpy

[![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)
[![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 3D microscopy data within [napari]. Currently only tracking of XYZ data is implemented.

## Installation

You can install `napari-trackpy` via [pip]:

    pip install napari-trackpy

To install latest development version :

    pip install git+https://github.com/rhoitink/napari-trackpy.git

## How to use this plugin?
* Load your XYZ data (using [napari-aicsimageio])
* Make sure to split channels into different layers, such that the layer only contains 3D (XYZ) data
* Open the widget for the tracking plugin via `Plugins` > `XYZ particle tracking`
* Optimize the tracking settings for your dataset, for an extensive description of the settings, visit [this tutorial](http://soft-matter.github.io/trackpy/dev/tutorial/tracking-3d.html)
* Save your tracking data into the `.xyz` file format using `Ctrl`+`S` (on the points layer) or via the menu `File` > `Save Selected Layer(s)...`

## Contributing

Contributions are very welcome. Tests can be run with [tox].

## License

Distributed under the terms of the [MIT] license,
"napari-trackpy" is free and open source software

## Issues

If you encounter any problems, please [file an issue] along with a detailed description.

[napari]: https://github.com/napari/napari
[trackpy]: https://github.com/soft-matter/trackpy
[napari-aicsimageio]: https://github.com/AllenCellModeling/napari-aicsimageio
[MIT]: http://opensource.org/licenses/MIT

[file an issue]: https://github.com/rhoitink/napari-trackpy/issues

[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rhoitink/napari-trackpy",
    "name": "napari-trackpy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Roy Hoitink",
    "author_email": "L.D.Hoitink@uu.nl",
    "download_url": "https://files.pythonhosted.org/packages/af/99/82a848c445ff052d9b0aedcb652bc7325adca4623f51f5017ba501a51e28/napari-trackpy-0.3.0.tar.gz",
    "platform": null,
    "description": "# napari-trackpy\n\n[![License MIT](https://img.shields.io/pypi/l/napari-trackpy.svg?color=green)](https://github.com/rhoitink/napari-trackpy/raw/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/napari-trackpy.svg?color=green)](https://pypi.org/project/napari-trackpy)\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-trackpy.svg?color=green)](https://python.org)\n[![tests](https://github.com/rhoitink/napari-trackpy/workflows/tests/badge.svg)](https://github.com/rhoitink/napari-trackpy/actions)\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-trackpy)](https://napari-hub.org/plugins/napari-trackpy)\n\nPlugin to do [trackpy] particle tracking on 3D microscopy data within [napari]. Currently only tracking of XYZ data is implemented.\n\n## Installation\n\nYou can install `napari-trackpy` via [pip]:\n\n    pip install napari-trackpy\n\nTo install latest development version :\n\n    pip install git+https://github.com/rhoitink/napari-trackpy.git\n\n## How to use this plugin?\n* Load your XYZ data (using [napari-aicsimageio])\n* Make sure to split channels into different layers, such that the layer only contains 3D (XYZ) data\n* Open the widget for the tracking plugin via `Plugins` > `XYZ particle tracking`\n* Optimize the tracking settings for your dataset, for an extensive description of the settings, visit [this tutorial](http://soft-matter.github.io/trackpy/dev/tutorial/tracking-3d.html)\n* Save your tracking data into the `.xyz` file format using `Ctrl`+`S` (on the points layer) or via the menu `File` > `Save Selected Layer(s)...`\n\n## Contributing\n\nContributions are very welcome. Tests can be run with [tox].\n\n## License\n\nDistributed under the terms of the [MIT] license,\n\"napari-trackpy\" is free and open source software\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[trackpy]: https://github.com/soft-matter/trackpy\n[napari-aicsimageio]: https://github.com/AllenCellModeling/napari-aicsimageio\n[MIT]: http://opensource.org/licenses/MIT\n\n[file an issue]: https://github.com/rhoitink/napari-trackpy/issues\n\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Plugin to do trackpy particle tracking on microscopy data within napari",
    "version": "0.3.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/rhoitink/napari-trackpy/issues",
        "Documentation": "https://github.com/rhoitink/napari-trackpy#README.md",
        "Homepage": "https://github.com/rhoitink/napari-trackpy",
        "Source Code": "https://github.com/rhoitink/napari-trackpy",
        "User Support": "https://github.com/rhoitink/napari-trackpy/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "797d578e7c1f19929fcc7d9d8a4ada624a1337c79d7fdd01b493349c08d4d625",
                "md5": "f62801b4b192380c4b2559420dc57486",
                "sha256": "876f2e2f050955e605e6c25e0e474cc5846e65091a09133d2d8418b44296246f"
            },
            "downloads": -1,
            "filename": "napari_trackpy-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f62801b4b192380c4b2559420dc57486",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8432,
            "upload_time": "2023-11-09T09:29:03",
            "upload_time_iso_8601": "2023-11-09T09:29:03.289142Z",
            "url": "https://files.pythonhosted.org/packages/79/7d/578e7c1f19929fcc7d9d8a4ada624a1337c79d7fdd01b493349c08d4d625/napari_trackpy-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "af9982a848c445ff052d9b0aedcb652bc7325adca4623f51f5017ba501a51e28",
                "md5": "d7dc1951699d355bc505cbbb3601f26b",
                "sha256": "fcbdc8cbd7cc031fcea244627617f97c10f2b655df301229e4cb2c4eab832c85"
            },
            "downloads": -1,
            "filename": "napari-trackpy-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d7dc1951699d355bc505cbbb3601f26b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12185,
            "upload_time": "2023-11-09T09:29:04",
            "upload_time_iso_8601": "2023-11-09T09:29:04.688768Z",
            "url": "https://files.pythonhosted.org/packages/af/99/82a848c445ff052d9b0aedcb652bc7325adca4623f51f5017ba501a51e28/napari-trackpy-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-09 09:29:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rhoitink",
    "github_project": "napari-trackpy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "napari-trackpy"
}
        
Elapsed time: 0.14875s