Home

Awesome

napari-tiler

License PyPI Python Version tests codecov napari hub PyPI - Downloads Code style: black Development Status

N-dimensional tiling and merging support for napari

This plugin allows the user to split an image into a stack of tiles and subsequently merge the tiles to reconstruct the orignal image. See Tiler by @thelay for more details.

This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

<!-- Don't miss the full getting started guide to set up your new package: https://github.com/napari/cookiecutter-napari-plugin#getting-started and review the napari docs for plugin developers: https://napari.org/plugins/stable/index.html -->

Installation

Option 1 (recommended)

You can install napari-tiler from the napari plugin manager. Go to Plugins -> Install/Uninstall Package(s), then search for napari-tiler. Click Install.

Option 2

You can also install napari-tiler via pip:

pip install napari-tiler

To install latest development version:

pip install git+https://github.com/tdmorello/napari-tiler.git

Quick Start

  1. Open a file in napari. The file may have any number of dimensions (e.g. z-stack, time series, ...)
  2. Start the plugin ( Plugins -> napari-tiler: make_tiles )
  3. Select the input layer from the dropdown box
  4. Select parameters for tiling
  5. Click Run

Contributing

This project uses Poetry for dependency management. To set up the development environment, it is recommended to use:

conda env create -f environment.yaml

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-tiler" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.