Metadata-Version: 2.4
Name: leonardo_toolset
Version: 1.0.1
Summary: Leonardo: an LSFM image processing toolset
Author-email: Yu Liu <liuyu9671@gmail.com>
License: MIT License
        
        Copyright (c) 2024 peng-lab
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/peng-lab/leonardo_toolset
Project-URL: Bug Tracker, https://github.com/peng-lab/leonardo_toolset/issues
Project-URL: Documentation, https://github.com/peng-lab/leonardo_toolset#README.md
Project-URL: Source Code, https://github.com/peng-lab/leonardo_toolset
Project-URL: User Support, https://github.com/peng-lab/leonardo_toolset/issues
Keywords: leonardo_toolset
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jax
Requires-Dist: scikit-image
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: tqdm
Requires-Dist: matplotlib
Requires-Dist: dm-haiku
Requires-Dist: SimpleITK
Requires-Dist: jaxwt
Requires-Dist: ptwt
Requires-Dist: PyWavelets
Requires-Dist: antspyx
Requires-Dist: opencv-python
Requires-Dist: colour
Requires-Dist: open3d
Requires-Dist: h5py
Requires-Dist: bioio<2
Requires-Dist: bioio-tifffile
Requires-Dist: jinja2
Requires-Dist: pyyaml
Requires-Dist: bioio-ome-tiff<1.2
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.1.1; extra == "dev"
Requires-Dist: coverage>=5.1; extra == "dev"
Requires-Dist: ipython>=7.15.0; extra == "dev"
Requires-Dist: m2r2>=0.2.7; extra == "dev"
Requires-Dist: pytest-runner>=5.2; extra == "dev"
Requires-Dist: Sphinx>=3.4.3; extra == "dev"
Requires-Dist: sphinx_rtd_theme>=0.5.1; extra == "dev"
Requires-Dist: tox>=3.15.2; extra == "dev"
Requires-Dist: twine>=3.1.1; extra == "dev"
Requires-Dist: wheel>=0.34.2; extra == "dev"
Provides-Extra: test
Requires-Dist: black>=19.10b0; extra == "test"
Requires-Dist: codecov>=2.1.4; extra == "test"
Requires-Dist: flake8>=3.8.3; extra == "test"
Requires-Dist: flake8-debugger>=3.2.1; extra == "test"
Requires-Dist: pytest>=5.4.3; extra == "test"
Requires-Dist: pytest-cov>=2.9.0; extra == "test"
Requires-Dist: pytest-raises>=0.11; extra == "test"
Requires-Dist: tox>=3.15.2; extra == "test"
Provides-Extra: all
Requires-Dist: bump-my-version>=1.1.1; extra == "all"
Requires-Dist: coverage>=5.1; extra == "all"
Requires-Dist: ipython>=7.15.0; extra == "all"
Requires-Dist: m2r2>=0.2.7; extra == "all"
Requires-Dist: pytest-runner>=5.2; extra == "all"
Requires-Dist: Sphinx>=3.4.3; extra == "all"
Requires-Dist: sphinx_rtd_theme>=0.5.1; extra == "all"
Requires-Dist: tox>=3.15.2; extra == "all"
Requires-Dist: twine>=3.1.1; extra == "all"
Requires-Dist: wheel>=0.34.2; extra == "all"
Requires-Dist: black>=19.10b0; extra == "all"
Requires-Dist: codecov>=2.1.4; extra == "all"
Requires-Dist: flake8>=3.8.3; extra == "all"
Requires-Dist: flake8-debugger>=3.2.1; extra == "all"
Requires-Dist: pytest>=5.4.3; extra == "all"
Requires-Dist: pytest-cov>=2.9.0; extra == "all"
Requires-Dist: pytest-raises>=0.11; extra == "all"
Dynamic: license-file

# Leonardo: a toolset to remove sample-induced aberrations in light sheet microscopy images 

[![Build Status](https://github.com/peng-lab/leonardo_toolset/workflows/Build%20Main/badge.svg)](https://github.com/peng-lab/leonardo_toolset/actions)
---

*Leonardo* is a toolbox able to resolve all sample-induced aberrations in selective plane illumination microscopy (SPIM, also called light-sheet fluorescence microscopy, LSFM) by using two major modules: (1) **DeStripe** removes the stripe artifacts caused by light absorption; (2) **FUSE** reconstructs one single high-quality image from dual-sided illumination and/or dual-sided detection while eliminating optical distortions (ghosts) caused by light refraction. 

## Documentation and Tutorials:

https://leonardo-lsfm.readthedocs.io/en/latest/installation.html

## Installation

**Stable Release:** `pip install leonardo_toolset`<br>
**Development Head:** `pip install git+https://github.com/peng-lab/leonardo_toolset.git`

**Full software including napari plugins:** `pip install leonardo_toolset[napari]`<br>

This **leonardo_toolset** package contains everything you need for using the toolset, including batch processing support for different workflows, such as running destriping then fusion. If you need only one specific component, you can find more info below:

<details>
    <summary>More details about the leonardo_toolset package</summary>

    ## packages for core componets:

    * Leonardo-DeStripe: https://github.com/peng-lab/lsfm_destripe
    * Leonardo-FUSE: https://github.com/peng-lab/lsfm_fuse

    ## packages for napari plugins:

    * plugin for Leonardo-DeStripe: https://github.com/peng-lab/lsfm_destripe_napari 
    * plugin for Leonardo-FUSE: https://github.com/peng-lab/lsfm_fusion_napari

</details>


## Development

See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.

**MIT license**

