Metadata-Version: 2.1
Name: locan
Version: 0.16.0
Summary: Analysis software for single-molecule localization microscopy
Author: Locan Developers
Maintainer: Sören Doose
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.
        
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: License :: OSI Approved :: BSD License
Classifier: Programming Language :: C
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
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.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: asdf
Requires-Dist: tifffile
Requires-Dist: ruamel.yaml
Requires-Dist: fast-histogram
Requires-Dist: boost-histogram
Requires-Dist: lmfit
Requires-Dist: protobuf
Requires-Dist: shapely!=2.0.0,!=2.0.1
Requires-Dist: networkx
Requires-Dist: scikit-learn
Requires-Dist: scikit-image
Requires-Dist: matplotlib!=3.8.0
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: numpy>1.20.0
Requires-Dist: tqdm
Requires-Dist: cython
Requires-Dist: tomli>=1.1.0; python_version < "3.11"
Requires-Dist: qtpy!=2.3.0
Requires-Dist: typing_extensions
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: test-qt
Requires-Dist: pytest; extra == "test-qt"
Requires-Dist: PyQt5; extra == "test-qt"
Requires-Dist: pytest-qt; python_version < "3.11" and extra == "test-qt"
Provides-Extra: pyside2
Requires-Dist: PySide2; extra == "pyside2"
Provides-Extra: pyqt5
Requires-Dist: PyQt5; extra == "pyqt5"
Provides-Extra: color
Requires-Dist: colorcet; extra == "color"
Provides-Extra: track
Requires-Dist: trackpy; extra == "track"
Provides-Extra: register
Requires-Dist: open3d-cpu!=0.12.0; (platform_system == "Linux" and python_version < "3.11") and extra == "register"
Requires-Dist: open3d!=0.12.0; (platform_system != "Linux" and python_version < "3.11") and extra == "register"
Provides-Extra: napari
Requires-Dist: napari; extra == "napari"
Provides-Extra: scatter-density
Requires-Dist: mpl_scatter_density; extra == "scatter-density"
Provides-Extra: html
Requires-Dist: requests; extra == "html"
Provides-Extra: hdf5
Requires-Dist: h5py; extra == "hdf5"
Provides-Extra: hdbscan
Requires-Dist: hdbscan; extra == "hdbscan"
Provides-Extra: all
Requires-Dist: PyQt5; extra == "all"
Requires-Dist: locan[test]; extra == "all"
Requires-Dist: colorcet; extra == "all"
Requires-Dist: trackpy; extra == "all"
Requires-Dist: locan[register]; extra == "all"
Requires-Dist: napari; extra == "all"
Requires-Dist: mpl_scatter_density; extra == "all"
Requires-Dist: requests; extra == "all"
Requires-Dist: h5py; extra == "all"
Requires-Dist: hdbscan; extra == "all"
Provides-Extra: gpu
Requires-Dist: cupy; extra == "gpu"
Requires-Dist: open3d!=0.12.0; python_version < "3.11" and extra == "gpu"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: ray; extra == "docs"
Provides-Extra: dev
Requires-Dist: locan[test]; extra == "dev"
Requires-Dist: coverage[toml]; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: black~=23.0; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: asv; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: numpy>1.20.0; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: types-protobuf; extra == "dev"
Requires-Dist: pandas-stubs; extra == "dev"

![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. 
