locan


Namelocan JSON
Version 0.19.1 PyPI version JSON
download
home_page
SummaryAnalysis software for single-molecule localization microscopy
upload_time2024-03-14 11:52:12
maintainerSören Doose
docs_urlNone
authorLocan Developers
requires_python>=3.9
licenseBSD 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.
keywords fluorescence super-resolution single-molecule localization microscopy smlm storm dstorm palm paint
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![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. 

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "locan",
    "maintainer": "S\u00f6ren Doose",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "fluorescence,super-resolution, single-molecule localization microscopy,smlm,storm,dstorm,palm,paint",
    "author": "Locan Developers",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/08/77/1397f9d1e3772e21efee6eb1341440ff72c0ad2bc747a8805745af89d62f/locan-0.19.1.tar.gz",
    "platform": null,
    "description": "![logo](./docs/_static/logo.png) Welcome to Locan\n==================================================\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5722472.svg)](https://doi.org/10.5281/zenodo.5722472)\n[![PyPI](https://img.shields.io/pypi/v/locan)](https://pypi.org/project/locan/)\n[![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/locan)](https://anaconda.org/conda-forge/locan)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/locan)](https://www.python.org/)\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/super-resolution/locan)](https://github.com/super-resolution/Locan)\n[![GitHub last commit](https://img.shields.io/github/last-commit/super-resolution/locan)](https://github.com/super-resolution/Locan/commits/main)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![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)\n[![codecov](https://codecov.io/gh/super-resolution/Locan/branch/main/graph/badge.svg?token=XTZRIIVOGE)](https://codecov.io/gh/super-resolution/Locan)\n[![Documentation Status](https://readthedocs.org/projects/locan/badge/?version=latest)](https://locan.readthedocs.io/en/latest/?badge=latest)\n\n\nLocan is a python-based library with code for analyzing fluorescence super-resolution\nmicroscopy data.\n\nGetting Started\n----------------\n\nTo install the package please read the [instructions](https://locan.readthedocs.io/en/latest/source/installation.html) or:\n\n    pip install locan\n\nor:\n\n    conda install -c conda-forge locan\n\nFor details on usage and development please read the [documentation](https://locan.readthedocs.io).\n\n[Tutorials](https://locan.readthedocs.io/en/latest/tutorials/tutorials.html) are provided as Jupyter notebooks.\n\nYou can use the package in a docker container as described in [docker/README.md](docker/README.md).\n\nContributing\n------------\n\nDevelopment takes place on the [Locan GitHub page](https://github.com/super-resolution/Locan).\n\nPlease use [GitHub issues](https://github.com/super-resolution/Locan/issues) to report bugs and feature requests. \nUse [GitHub discussions](https://github.com/super-resolution/Locan/discussions) for Q&A.\n\nPlease read [documentation on development](https://locan.readthedocs.io/en/latest/source/development.html) for details on how to help develop this project further.\n\nDevelopers\n----------\n\nSee the list of [contributors](https://locan.readthedocs.io/en/latest/source/contributions.html) who participated in this project.\n\nLicense\n-------\n\nThis project is licensed under the BSD-3 License - see the [LICENSE](LICENSE.md) file for details.\n\nCiting\n-------\n\nIf you want to acknowledge locan please cite the following publication:\n\nS\u00f6ren Doose, LOCAN: a python library for analyzing single-molecule localization microscopy data, Bioinformatics 38(9), 2670\u20132672, 2022,\nhttps://doi.org/10.1093/bioinformatics/btac160\n\nOr cite this repository using the DOI provided by zenodo:\n\n[doi.org/10.5281/zenodo.5722472](https://doi.org/10.5281/zenodo.5722472)\n\nNote this DOI will resolve to all versions of locan. \nTo cite a specific version please find the DOI of that version on the zenodo page. \n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2018-2022, Biotechnologie und Biophysik - Universit\u00e4t W\u00fcrzburg 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. ",
    "summary": "Analysis software for single-molecule localization microscopy",
    "version": "0.19.1",
    "project_urls": {
        "changelog": "https://github.com/super-resolution/locan",
        "documentation": "https://locan.readthedocs.io/",
        "homepage": "https://github.com/super-resolution/locan",
        "issues": "https://github.com/super-resolution/locan/issues",
        "repository": "https://github.com/super-resolution/locan"
    },
    "split_keywords": [
        "fluorescence",
        "super-resolution",
        " single-molecule localization microscopy",
        "smlm",
        "storm",
        "dstorm",
        "palm",
        "paint"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bc1e401e051fdb017fe97de65c425021c014eeb39a284f15648653c09c931185",
                "md5": "284666cfdf64db0a9166a2dff040d842",
                "sha256": "dc722667f4729354e333a982a6ad27ad04dfbd9020710c8c9c01a41d64b77dc8"
            },
            "downloads": -1,
            "filename": "locan-0.19.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "284666cfdf64db0a9166a2dff040d842",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 1720796,
            "upload_time": "2024-03-14T11:52:10",
            "upload_time_iso_8601": "2024-03-14T11:52:10.107522Z",
            "url": "https://files.pythonhosted.org/packages/bc/1e/401e051fdb017fe97de65c425021c014eeb39a284f15648653c09c931185/locan-0.19.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08771397f9d1e3772e21efee6eb1341440ff72c0ad2bc747a8805745af89d62f",
                "md5": "24ebd2b95f8fbf706ed07cbc00984f26",
                "sha256": "5c8266af9339b1a75f060312454572e006fa797cd8a95cd93df87a738995e7c8"
            },
            "downloads": -1,
            "filename": "locan-0.19.1.tar.gz",
            "has_sig": false,
            "md5_digest": "24ebd2b95f8fbf706ed07cbc00984f26",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 2200198,
            "upload_time": "2024-03-14T11:52:12",
            "upload_time_iso_8601": "2024-03-14T11:52:12.388042Z",
            "url": "https://files.pythonhosted.org/packages/08/77/1397f9d1e3772e21efee6eb1341440ff72c0ad2bc747a8805745af89d62f/locan-0.19.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-14 11:52:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "super-resolution",
    "github_project": "locan",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "locan"
}
        
Elapsed time: 0.23106s