napari-locan


Namenapari-locan JSON
Version 0.4.0 PyPI version JSON
download
home_page
SummaryUse locan methods in napari for single-molecule localization microscopy data.
upload_time2023-11-08 12:55:39
maintainerSören Doose
docs_urlNone
authornapari-locan Developers
requires_python>=3.9
licenseBSD 3-Clause License Copyright (c) 2022-23, Biotechnologie und Biophysik - Universität Würzburg All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of napari-locan nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords napari plugin locan
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![logo](./docs/_static/logo.png) napari-locan
==================================================

[![License](https://img.shields.io/github/license/super-resolution/napari-locan)](https://github.com/super-resolution/napari-locan/blob/main/LICENSE.md)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-locan)](https://napari-hub.org/plugins/napari-locan)
[![PyPI](https://img.shields.io/pypi/v/napari-locan.svg?color=green)](https://pypi.org/project/napari-locan)
[![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/napari-locan)](https://anaconda.org/conda-forge/napari-locan)
[![Python Version](https://img.shields.io/pypi/pyversions/napari-locan.svg?color=green)](https://python.org)
[![tests](https://github.com/super-resolution/napari-locan/workflows/tests/badge.svg)](https://github.com/super-resolution/napari-locan/actions)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![codecov](https://codecov.io/gh/super-resolution/napari-locan/branch/main/graph/badge.svg)](https://codecov.io/gh/super-resolution/napari-locan)
[![Documentation Status](https://readthedocs.org/projects/napari-locan/badge/?version=latest)](https://napari-locan.readthedocs.io/en/latest/?badge=latest)

Load, visualize and analyze single-molecule localization microscopy (SMLM) data.

napari-locan is a napari plugin that implements a subset of methods from [locan],
a python-based library with code for analyzing SMLM data.
Locan provides extended functionality that is better suited for script- or
notebook-based analysis procedures.
napari-locan is well suited for exploratory data analysis within napari.

For details on usage and development of napari-locan please read the [documentation].

## Installation

Make sure to have Qt bindings installed in your python environment of choice.

You can install napari-locan from PyPI:

    pip install napari-locan

or from conda-forge:

    mamba install -c conda-forge napari-locan

Please read the [documentation on installation] for more details.

## Usage

![](https://github.com/super-resolution/napari-locan/raw/main/docs/resources/screenshot_0.png?raw=true)

Please read the [documentation] for details.

## Contributing

Contributions are very welcome.
Please read the [documentation on development] for details.

## Credit

The plugin was developed in the Department of Biotechnology and Biophysics,
Würzburg University, Germany.
It is based on locan. So credit goes to the [locan developers]
and can be [cited](https://github.com/super-resolution/napari-locan/blob/main/CITATION.cff).

## License

Distributed under the terms of the
[BSD-3](http://opensource.org/licenses/BSD-3-Clause)
license, "napari-locan" is free and open source software.
See the [LICENSE](https://github.com/super-resolution/napari-locan/blob/main/LICENSE.md) file for details.

## Issues

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

----------------------------------

This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.

[napari]: https://github.com/napari/napari
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin

[locan]: https://github.com/super-resolution/locan
[locan developers]: https://github.com/super-resolution/locan

[documentation]: https://napari-locan.readthedocs.io
[documentation on installation]: https://napari-locan.readthedocs.io/en/latest/source/installation.html
[documentation on development]: https://napari-locan.readthedocs.io/en/latest/source/development.html
[file an issue]: https://github.com/super-resolution/napari-locan/issues

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "napari-locan",
    "maintainer": "S\u00f6ren Doose",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "napari plugin,locan",
    "author": "napari-locan Developers",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/76/71/68b4ba431852d5969e5361c9ec652b6336d44781b2272c0d417037bc6372/napari-locan-0.4.0.tar.gz",
    "platform": null,
    "description": "![logo](./docs/_static/logo.png) napari-locan\r\n==================================================\r\n\r\n[![License](https://img.shields.io/github/license/super-resolution/napari-locan)](https://github.com/super-resolution/napari-locan/blob/main/LICENSE.md)\r\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-locan)](https://napari-hub.org/plugins/napari-locan)\r\n[![PyPI](https://img.shields.io/pypi/v/napari-locan.svg?color=green)](https://pypi.org/project/napari-locan)\r\n[![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/napari-locan)](https://anaconda.org/conda-forge/napari-locan)\r\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-locan.svg?color=green)](https://python.org)\r\n[![tests](https://github.com/super-resolution/napari-locan/workflows/tests/badge.svg)](https://github.com/super-resolution/napari-locan/actions)\r\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\r\n[![codecov](https://codecov.io/gh/super-resolution/napari-locan/branch/main/graph/badge.svg)](https://codecov.io/gh/super-resolution/napari-locan)\r\n[![Documentation Status](https://readthedocs.org/projects/napari-locan/badge/?version=latest)](https://napari-locan.readthedocs.io/en/latest/?badge=latest)\r\n\r\nLoad, visualize and analyze single-molecule localization microscopy (SMLM) data.\r\n\r\nnapari-locan is a napari plugin that implements a subset of methods from [locan],\r\na python-based library with code for analyzing SMLM data.\r\nLocan provides extended functionality that is better suited for script- or\r\nnotebook-based analysis procedures.\r\nnapari-locan is well suited for exploratory data analysis within napari.\r\n\r\nFor details on usage and development of napari-locan please read the [documentation].\r\n\r\n## Installation\r\n\r\nMake sure to have Qt bindings installed in your python environment of choice.\r\n\r\nYou can install napari-locan from PyPI:\r\n\r\n    pip install napari-locan\r\n\r\nor from conda-forge:\r\n\r\n    mamba install -c conda-forge napari-locan\r\n\r\nPlease read the [documentation on installation] for more details.\r\n\r\n## Usage\r\n\r\n![](https://github.com/super-resolution/napari-locan/raw/main/docs/resources/screenshot_0.png?raw=true)\r\n\r\nPlease read the [documentation] for details.\r\n\r\n## Contributing\r\n\r\nContributions are very welcome.\r\nPlease read the [documentation on development] for details.\r\n\r\n## Credit\r\n\r\nThe plugin was developed in the Department of Biotechnology and Biophysics,\r\nW\u00fcrzburg University, Germany.\r\nIt is based on locan. So credit goes to the [locan developers]\r\nand can be [cited](https://github.com/super-resolution/napari-locan/blob/main/CITATION.cff).\r\n\r\n## License\r\n\r\nDistributed under the terms of the\r\n[BSD-3](http://opensource.org/licenses/BSD-3-Clause)\r\nlicense, \"napari-locan\" is free and open source software.\r\nSee the [LICENSE](https://github.com/super-resolution/napari-locan/blob/main/LICENSE.md) file for details.\r\n\r\n## Issues\r\n\r\nIf you encounter any problems, please [file an issue] along with a detailed description.\r\n\r\n----------------------------------\r\n\r\nThis [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.\r\n\r\n[napari]: https://github.com/napari/napari\r\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\r\n[@napari]: https://github.com/napari\r\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\r\n\r\n[locan]: https://github.com/super-resolution/locan\r\n[locan developers]: https://github.com/super-resolution/locan\r\n\r\n[documentation]: https://napari-locan.readthedocs.io\r\n[documentation on installation]: https://napari-locan.readthedocs.io/en/latest/source/installation.html\r\n[documentation on development]: https://napari-locan.readthedocs.io/en/latest/source/development.html\r\n[file an issue]: https://github.com/super-resolution/napari-locan/issues\r\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2022-23, Biotechnologie und Biophysik - Universit\u00e4t W\u00fcrzburg All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  * Neither the name of napari-locan nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Use locan methods in napari for single-molecule localization microscopy data.",
    "version": "0.4.0",
    "project_urls": {
        "changelog": "https://github.com/super-resolution/napari-locan/CHANGES.rst",
        "documentation": "https://napari-locan.readthedocs.io/",
        "homepage": "https://github.com/super-resolution/napari-locan",
        "issues": "https://github.com/super-resolution/napari-locan/issues",
        "repository": "https://github.com/super-resolution/napari-locan"
    },
    "split_keywords": [
        "napari plugin",
        "locan"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce90b2d2bcf57e4dd5b46b30c768a82619c449fbe23de613324193f13ab9da39",
                "md5": "98ebb3eea659ab0cc9501d7849f46682",
                "sha256": "c32eb8601574700bb81d960c28d4fe9412548a50cddc3596d2cafb98dac740f1"
            },
            "downloads": -1,
            "filename": "napari_locan-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "98ebb3eea659ab0cc9501d7849f46682",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 81872,
            "upload_time": "2023-11-08T12:55:38",
            "upload_time_iso_8601": "2023-11-08T12:55:38.021594Z",
            "url": "https://files.pythonhosted.org/packages/ce/90/b2d2bcf57e4dd5b46b30c768a82619c449fbe23de613324193f13ab9da39/napari_locan-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "767168b4ba431852d5969e5361c9ec652b6336d44781b2272c0d417037bc6372",
                "md5": "c988b91d9e4ce4ccbb65278b889c9f74",
                "sha256": "9f6e50e2726a9941c67fae5870f10507e4f146ac0f90f18a014f8fe61b7ade89"
            },
            "downloads": -1,
            "filename": "napari-locan-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c988b91d9e4ce4ccbb65278b889c9f74",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 358316,
            "upload_time": "2023-11-08T12:55:39",
            "upload_time_iso_8601": "2023-11-08T12:55:39.872082Z",
            "url": "https://files.pythonhosted.org/packages/76/71/68b4ba431852d5969e5361c9ec652b6336d44781b2272c0d417037bc6372/napari-locan-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-08 12:55:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "super-resolution",
    "github_project": "napari-locan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "napari-locan"
}
        
Elapsed time: 0.32311s