Metadata-Version: 2.4
Name: fractal-lif-converters
Version: 0.7.0
Summary: Converter from the Lif files (Leica Microscope) to OME-Zarr format.
Author-email: Lorenzo Cerrone <lorenzo.cerrone@uzh.ch>
License: BSD-3-Clause
License-File: LICENSE
Requires-Python: <3.15,>=3.11
Requires-Dist: fractal-task-tools<0.6.0,>=0.5.0
Requires-Dist: imagecodecs
Requires-Dist: liffile>=2026.2.16
Requires-Dist: ngio<0.6.0,>=0.5.8
Requires-Dist: numpy
Requires-Dist: ome-zarr-converters-tools<0.11.0,>=0.10.0
Requires-Dist: polars
Requires-Dist: pydantic
Requires-Dist: zarrs
Provides-Extra: dev
Requires-Dist: devtools; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: jsonschema; extra == 'dev'
Requires-Dist: matplotlib; extra == 'dev'
Requires-Dist: notebook; extra == 'dev'
Requires-Dist: plotly; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: requests; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: ty; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mike; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Provides-Extra: test
Requires-Dist: devtools; extra == 'test'
Requires-Dist: jsonschema; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pyyaml; extra == 'test'
Requires-Dist: requests; extra == 'test'
Description-Content-Type: text/markdown

# Fractal LIF Converters

[![CI (build and test)](https://github.com/fractal-analytics-platform/fractal-lif-converters/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/fractal-analytics-platform/fractal-lif-converters/actions/workflows/build_and_test.yml)
[![codecov](https://codecov.io/gh/fractal-analytics-platform/fractal-lif-converters/graph/badge.svg?token=YTN1VbbTeq)](https://codecov.io/gh/fractal-analytics-platform/fractal-lif-converters)

A collection of [Fractal](https://fractal-analytics-platform.github.io/) tasks
to convert Leica `.lif` files into [OME-Zarr](https://ngff.openmicroscopy.org/)
format.

## Tasks

| Task | Use case |
|---|---|
| `Convert Lif Plate to OME-Zarr` | Convert a `.lif` containing a plate-shaped tile-scan into an OME-Zarr HCS plate. |
| `Convert Lif Image to OME-Zarr` | Convert a single image (single-position, multi-position, or mosaic) into a standalone OME-Zarr image. |

Each task is a Fractal **compound task**: an init step parses the `.lif`
metadata and builds the parallelization list, and a compute step writes the
image data well-by-well (or scene-by-scene).

## Installation

```bash
pip install fractal-lif-converters
```

## Part of the OME-Zarr converters ecosystem

This converter is a thin, format-specific layer built on
[`ome-zarr-converters-tools`](https://github.com/BioVisionCenter/ome-zarr-converters-tools),
the shared engine that handles tiling, image registration, and OME-Zarr writing for
the whole Fractal converter family. Because they all share that engine, every
converter offers the same options, behavior, and development workflow.

Sibling converters built on the same tooling:

- [`fractal-czi-converters`](https://github.com/fractal-analytics-platform/fractal-czi-converters) — Zeiss `.czi`
- [`fractal-nd2-converters`](https://github.com/fractal-analytics-platform/fractal-nd2-converters) — Nikon `.nd2`
- [`fractal-uzh-converters`](https://github.com/fractal-analytics-platform/fractal-uzh-converters) — HCS plates (Operetta, ScanR, CQ3K, CellVoyager, ImageXpress, custom TIFF)

## Documentation

Full documentation — including the supported file layouts, all converter
parameters, and the condition-table format — is available at
<https://fractal-analytics-platform.github.io/fractal-lif-converters/>.
