locan

Localization analysis software for super-resolution microscopy

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

Science Score: 85.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
    Found 9 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • 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.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Localization analysis software for super-resolution microscopy

Basic Info
  • Host: GitHub
  • Owner: super-resolution
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage: https://locan.readthedocs.io
  • Size: 10 MB
Statistics
  • Stars: 22
  • Watchers: 6
  • Forks: 2
  • Open Issues: 0
  • Releases: 15
Created about 8 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

logo Welcome to Locan

DOI PyPI Conda (channel only) PyPI - Python Version GitHub release (latest by date) GitHub last commit Code style: black Tests codecov Documentation Status

Locan is a python-based library with code for analyzing fluorescence super-resolution microscopy data.

Getting Started

To install the package please read the instructions or:

pip install locan

or:

conda install -c conda-forge locan

For details on usage and development please read the documentation.

Tutorials are provided as Jupyter notebooks.

You can use the package in a docker container as described in docker/README.md.

Contributing

Development takes place on the Locan GitHub page.

Please use GitHub issues to report bugs and feature requests. Use GitHub discussions for Q&A.

Please read documentation on development for details on how to help develop this project further.

Developers

See the list of contributors who participated in this project.

License

This project is licensed under the BSD-3 License - see the LICENSE file for details.

Citing

If you want to acknowledge locan please cite the following publication:

Sören Doose, LOCAN: a python library for analyzing single-molecule localization microscopy data, Bioinformatics 38(9), 2670–2672, 2022, https://doi.org/10.1093/bioinformatics/btac160

Or cite this repository using the DOI provided by zenodo:

doi.org/10.5281/zenodo.5722472

Note this DOI will resolve to all versions of locan. To cite a specific version please find the DOI of that version on the zenodo page.

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.x.x"
doi: "10.5281/zenodo.5722472"
date-released: "09.08.2025"
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: 4
  • Watch event: 1
  • Delete event: 10
  • Push event: 49
  • Pull request event: 16
  • Create event: 13
Last Year
  • Release event: 4
  • Watch event: 1
  • Delete event: 10
  • Push event: 49
  • Pull request event: 16
  • Create event: 13

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 783
  • Total Committers: 4
  • Avg Commits per committer: 195.75
  • Development Distribution Score (DDS): 0.005
Top Committers
Name Email Commits
sdoose s****e@u****e 779
Felix f****e@w****e 2
swolter s****r@s****m 1
felixwaeldchen 4****n@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 70
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.3
  • Merged pull requests: 65
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 19
  • Average time to close issues: N/A
  • Average time to close pull requests: about 3 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • sdoose (68)
  • refelix (1)
  • stevewolter (1)
  • felixwaeldchen (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 3,225 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 16
  • Total maintainers: 1
pypi.org: locan

Analysis software for single-molecule localization microscopy

  • Documentation: https://locan.readthedocs.io/
  • License: BSD 3-Clause License Copyright (c) 2018-2022, 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 the copyright holder 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. Locan makes use of libraries and code that are compatibly licensed as listed in the licences directory.
  • Latest release: 0.21.0
    published 7 months ago
  • Versions: 16
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 3,225 Last month
Rankings
Dependent packages count: 4.7%
Downloads: 8.0%
Average: 11.5%
Dependent repos count: 21.7%
Maintainers (1)
Last synced: 6 months ago