Metadata-Version: 2.5
Name: clemreg
Version: 0.0.0
Summary: Core registration library for CLEM-Reg (placeholder — see the napari-clemreg plugin).
Project-URL: Homepage, https://github.com/krentzd/napari-clemreg
Project-URL: Source, https://github.com/krentzd/napari-clemreg
Project-URL: Bug Tracker, https://github.com/krentzd/napari-clemreg/issues
Project-URL: napari plugin (napari-clemreg), https://pypi.org/project/napari-clemreg/
Author-email: Daniel Krentzel <dkrentzel@pm.me>
Maintainer: The Francis Crick Institute
License: MIT
Keywords: CLEM,electron microscopy,fluorescence microscopy,image registration,microscopy,point cloud,registration
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# clemreg

**Core registration library for [CLEM-Reg](https://github.com/krentzd/napari-clemreg).**

> ⚠️ **Placeholder release.** This distribution currently reserves the `clemreg`
> name on PyPI. It contains no functionality yet. The CLEM-Reg algorithms live
> in the `napari-clemreg` plugin today and are being extracted into this
> standalone, napari-free core package.

## What this will be

`clemreg` is the pure-Python core of CLEM-Reg — correlative light and electron
microscopy (CLEM) image-volume registration based on common segmented structures
and point-cloud registration. It will operate on plain NumPy arrays with no
napari, Qt or GUI dependencies, so it can be used headlessly, scripted, and
tested in isolation:

- fluorescence (FM) and electron microscopy (EM) segmentation
- point-cloud sampling from segmentations
- point-cloud registration (Rigid / Affine / BCPD)
- image-volume warping
- export of results as a [MoBIE](https://mobie.github.io/) project

The napari widget will remain in a separate `napari-clemreg` package that depends
on this core.

## Install

Nothing to use here yet. For the working plugin:

```bash
pip install napari-clemreg
```

## Citation

If you use CLEM-Reg in your research, please cite the CLEM-Reg publication (see
the [main repository](https://github.com/krentzd/napari-clemreg)).

## License

MIT — see [LICENSE](https://github.com/krentzd/napari-clemreg/blob/main/LICENSE).
