Metadata-Version: 2.4
Name: locan
Version: 0.22.0
Summary: Analysis software for single-molecule localization microscopy
Author: Locan Developers
Maintainer: Sören Doose
License-Expression: BSD-3-Clause
Project-URL: homepage, https://github.com/super-resolution/locan
Project-URL: documentation, https://locan.readthedocs.io/
Project-URL: repository, https://github.com/super-resolution/locan
Project-URL: issues, https://github.com/super-resolution/locan/issues
Project-URL: changelog, https://github.com/super-resolution/locan
Keywords: fluorescence,super-resolution, single-molecule localization microscopy,smlm,storm,dstorm,palm,paint
Classifier: Environment :: Console
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: C
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: asdf
Requires-Dist: boost-histogram
Requires-Dist: cython
Requires-Dist: fast-histogram
Requires-Dist: lazy_loader>=0.3
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: numpy>1.20.0
Requires-Dist: pandas
Requires-Dist: protobuf>=6.31.1
Requires-Dist: qtpy!=2.3.0
Requires-Dist: ruamel.yaml
Requires-Dist: scikit-image
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: shapely!=2.0.0,!=2.0.1
Requires-Dist: tifffile
Requires-Dist: tqdm
Requires-Dist: typing_extensions
Provides-Extra: color
Requires-Dist: colorcet; extra == "color"
Provides-Extra: hdf5
Requires-Dist: h5py; extra == "hdf5"
Provides-Extra: http
Requires-Dist: httpx; extra == "http"
Provides-Extra: napari
Requires-Dist: napari>=0.5.3; extra == "napari"
Provides-Extra: pyqt5
Requires-Dist: PyQt5; extra == "pyqt5"
Provides-Extra: pyside2
Requires-Dist: PySide2; extra == "pyside2"
Provides-Extra: pyside6
Requires-Dist: pyside6!=6.8.0; extra == "pyside6"
Provides-Extra: register
Requires-Dist: open3d-cpu!=0.12.0; (sys_platform == "linux" and python_version <= "3.14") and extra == "register"
Requires-Dist: open3d!=0.12.0; (sys_platform != "inux" and python_version <= "3.14") and extra == "register"
Provides-Extra: scatter-density
Requires-Dist: mpl_scatter_density; extra == "scatter-density"
Requires-Dist: setuptools; extra == "scatter-density"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: track
Requires-Dist: trackpy; extra == "track"
Provides-Extra: all
Requires-Dist: colorcet; extra == "all"
Requires-Dist: h5py; extra == "all"
Requires-Dist: locan[http]; extra == "all"
Requires-Dist: locan[napari]; extra == "all"
Requires-Dist: locan[register]; extra == "all"
Requires-Dist: locan[scatter_density]; extra == "all"
Requires-Dist: locan[test]; extra == "all"
Requires-Dist: trackpy; extra == "all"
Dynamic: license-file

![logo](./docs/_static/logo.png) Welcome to Locan
==================================================

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5722472.svg)](https://doi.org/10.5281/zenodo.5722472)
[![PyPI](https://img.shields.io/pypi/v/locan)](https://pypi.org/project/locan/)
[![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/locan)](https://anaconda.org/conda-forge/locan)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/locan)](https://www.python.org/)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/super-resolution/locan)](https://github.com/super-resolution/Locan)
[![GitHub last commit](https://img.shields.io/github/last-commit/super-resolution/locan)](https://github.com/super-resolution/Locan/commits/main)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Tests](https://github.com/super-resolution/Locan/actions/workflows/Test_matrix_pip.yml/badge.svg?branch=main)](https://github.com/super-resolution/Locan/actions/workflows/Test_matrix_pip.yml)
[![codecov](https://codecov.io/gh/super-resolution/Locan/branch/main/graph/badge.svg?token=XTZRIIVOGE)](https://codecov.io/gh/super-resolution/Locan)
[![Documentation Status](https://readthedocs.org/projects/locan/badge/?version=latest)](https://locan.readthedocs.io/en/latest/?badge=latest)


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](https://locan.readthedocs.io/en/latest/source/installation.html) or:

    pip install locan

or:

    conda install -c conda-forge locan

For details on usage and development please read the [documentation](https://locan.readthedocs.io).

[Tutorials](https://locan.readthedocs.io/en/latest/tutorials/tutorials.html) are provided as Jupyter notebooks.

You can use the package in a docker container as described in [docker/README.md](docker/README.md).

Contributing
------------

Development takes place on the [Locan GitHub page](https://github.com/super-resolution/Locan).

Please use [GitHub issues](https://github.com/super-resolution/Locan/issues) to report bugs and feature requests. 
Use [GitHub discussions](https://github.com/super-resolution/Locan/discussions) for Q&A.

Please read [documentation on development](https://locan.readthedocs.io/en/latest/source/development.html) for details on how to help develop this project further.

Developers
----------

See the list of [contributors](https://locan.readthedocs.io/en/latest/source/contributions.html) who participated in this project.

License
-------

This project is licensed under the BSD-3 License - see the [LICENSE](LICENSE.md) 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](https://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. 
