napari-locan

Napari plugin to use locan methods in napari

https://github.com/super-resolution/napari-locan

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization super-resolution has institutional domain (www.super-resolution.biozentrum.uni-wuerzburg.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.5%) to scientific vocabulary

Keywords

napari-plugin
Last synced: 9 months ago · JSON representation ·

Repository

Napari plugin to use locan methods in napari

Basic Info
Statistics
  • Stars: 2
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 7
Topics
napari-plugin
Created about 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

logo napari-locan

License napari hub PyPI Conda (channel only) Python Version test-py-matrix Code style: black codecov Documentation Status

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:

conda install -c conda-forge napari-locan

Please read the documentation on installation for more details.

Usage

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.

License

Distributed under the terms of the BSD-3 license, "napari-locan" is free and open source software. See the LICENSE 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.

Owner

  • Name: Biotechnologie und Biophysik - Universität Würzburg
  • Login: super-resolution
  • Kind: organization
  • Location: Würzburg

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Doose"
  given-names: "Sören"
  orcid: "https://orcid.org/0000-0002-6983-1182"
title: "Locan"
version: ">=0.18.0"
doi: "10.5281/zenodo.5722472"
date-released: 2023
url: "https://github.com/super-resolution/Locan"
preferred-citation:
  type: article
  authors:
    - family-names: "Doose"
      given-names: "Sören"
      orcid: "https://orcid.org/0000-0002-6983-1182"
  doi: "10.1093/bioinformatics/btac160"
  journal: "Bioinformatics"
  start: 2670 # First page number
  end: 2672 # Last page number
  title: "LOCAN: a python library for analyzing single-molecule localization microscopy data"
  issue: 9
  volume: 38
  year: 2022

GitHub Events

Total
  • Release event: 2
  • Watch event: 2
  • Delete event: 4
  • Push event: 19
  • Pull request event: 10
  • Create event: 10
Last Year
  • Release event: 2
  • Watch event: 2
  • Delete event: 4
  • Push event: 19
  • Pull request event: 10
  • Create event: 10

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 25
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 25
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • sdoose (17)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 65 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 7
  • Total maintainers: 1
pypi.org: napari-locan

Use locan methods in napari for single-molecule localization microscopy data.

  • Documentation: https://napari-locan.readthedocs.io/
  • License: BSD 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.
  • Latest release: 0.7.0
    published about 1 year ago
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 65 Last month
Rankings
Dependent packages count: 9.5%
Average: 38.8%
Dependent repos count: 68.1%
Maintainers (1)
Last synced: 10 months ago

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • coactions/setup-xvfb v1 composite
  • codecov/codecov-action v3 composite
  • tlambert03/setup-qt-libs v1 composite
.github/workflows/test_os_matrix.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • coactions/setup-xvfb v1 composite
  • tlambert03/setup-qt-libs v1 composite
.github/workflows/test_py_matrix.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • coactions/setup-xvfb v1 composite
  • tlambert03/setup-qt-libs v1 composite
docs/requirements_rtd.txt pypi
  • 159 dependencies
pyproject.toml pypi
  • locan >=0.17
  • matplotlib <3.8.0
  • napari *
  • napari-matplotlib *
  • numpy *
  • qtpy *
.github/workflows/deploy_to_pypi.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/deploy_to_testpypi.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite