Skip to content

super-resolution/Locan

Repository files navigation

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.