Skip to main content

NucleiSky Banner

NucleiSky ✨🔬

Constellation-based point-set registration for microscopy in 2D and 3D Align calibrated partial views to whole-slide images or thick tissue volumes using landmark geometry.

PyPI License Downloads Open 2D App in Colab Open 3D App in Colab


✨ What is NucleiSky?

Microscopy alignment gets messy when images are rotated, scaled, or captured on completely different platforms. NucleiSky solves this by treating your nuclei like stars in a constellation.

Instead of relying on pixel intensity similarity, NucleiSky matches the geometry of the cells. Whether your data is a 2D field of view or a 3D tissue stack, NucleiSky finds the calibrated similarity transform that best overlaps two landmark constellations.

👩‍🔬 For the Biologist: The "Telescope" Setup

Imagine looking through a small telescope at a random patch of the night sky. Even without seeing the whole galaxy, you can figure out exactly where you are by matching your small star pattern against a full sky map. NucleiSky does the same for your tissue: it anchors high-magnification ROIs into whole-slide scans by estimating rotation, scale, and shift.

👨‍💻 For the Developer: The Constellation Engine

NucleiSky is a robust point-set registration pipeline built for real-world microscopy noise. It provides modular feature extraction, dynamically scaled RANSAC, geometric hashing, and tetrahedral pyramid matchers — ready to slot into automated spatial analysis pipelines.


⚡ Quickstart

Choose your setup and align your images in minutes:

🌟 Try it in the Browser (Fastest)

No installation required. Run our interactive apps directly in Google Colab:

🖥️ No-Code Desktop GUI

Prefer a local app? Use our standalone desktop installer.

🐍 Python Workflows (Local Installation)

To install the package for your own scripts:

pip install nucleisky

Use pip install "nucleisky[all]" when you also need optional segmentation, OME-Zarr, SimpleITK, and notebook dependencies. Core matching runs on CPU; GPU support only affects optional deep-learning segmentation backends such as Cellpose and InstanSeg.

2D Pipeline (ROI → Whole Slide)

  1. 2D Data Preparation
  2. 2D End-to-End Workflow
  3. Quality Control

3D Pipeline (Subvolume → Thick Tissue)

  1. 3D Data Preparation
  2. 3D End-to-End Workflow
  3. Quality Control

(Need a leaner installation? See our Installation Guide for modular backend options).


🔑 Key Capabilities

  • 2D & 3D registration: Shared constellation logic for flat slides and volumetric stacks. 3D workflows should be reviewed with manual QC before downstream use.
  • Scale-aware: Matches images captured at different pixel/voxel sizes when calibration metadata is correct.
  • Rotation-aware: Supports unrestricted rotations unless you configure an angle bound.
  • Modality-Agnostic: If you can segment the nuclei (or spots/cells), NucleiSky can match them.
  • Export-Ready: Saves transforms, warped hyperstacks, and QC overlays for downstream analysis.

⚠️ The Two Golden Rules (Make or Break)

  1. Pixel and Voxel size matter immensely. NucleiSky measures physical distances in micrometres. If your scale metadata (µm/px) is missing or wrong, the search bounds break, and alignment fails. Always verify your metadata! See Data Preparation.
  2. Segmentation quality drives match quality. NucleiSky registers point sets. Missing, massively merged, or noisy nuclei obscure the constellation and make matching much harder. See Segmentation.

📚 Documentation Index

Start Here

Quality Control & Troubleshooting

Developer Deep Dives


🤝 Contributing

We welcome PRs, feature ideas, and bug reports! For the fastest triage, please use our GitHub issue forms.

If you’re using NucleiSky in a new workflow, drop an issue and tell us:

  • What you’re aligning (restains, multi-round, ROI-to-reference, etc.)
  • What success looks like in your pipeline
  • What would make adoption easier for your lab

Need troubleshooting help? Please include a QC overlay from your save_dir/original/ folder when you open a bug report!


📢 Citation

If you find this tool useful in your research, please cite:

NucleiSky enables cross-scale multimodal registration of microscopy data using nuclei constellations.

Iván Hidalgo Cenalmor, Adán Olguín-Olguín, Carolina Prieto, Johannes Kumra Ahnlide, Pontus Nordenfelt, Ricardo Henriques, Mario Del Rosario, Guillaume Jacquemet bioRxiv 2026.06.29.735028;

doi: https://doi.org/10.64898/2026.06.29.735028

@article {Cenalmor2026,
	author = {Cenalmor, Iv{\'a}n Hidalgo and Olgu{\'\i}n-Olgu{\'\i}n, Ad{\'a}n and Prieto, Carolina and Ahnlide, Johannes Kumra and Nordenfelt, Pontus and Henriques, Ricardo and Del Rosario, Mario and Jacquemet, Guillaume},
	title = {NucleiSky enables cross-scale multimodal registration of microscopy data using nuclei constellations},
	elocation-id = {2026.06.29.735028},
	year = {2026},
	doi = {10.64898/2026.06.29.735028},
	publisher = {Cold Spring Harbor Laboratory},	
	URL = {https://www.biorxiv.org/content/early/2026/06/29/2026.06.29.735028},
	eprint = {https://www.biorxiv.org/content/early/2026/06/29/2026.06.29.735028.full.pdf},
	journal = {bioRxiv}
}

Metadata

Release files for nucleisky 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nucleisky 0.0.1
File Size Uploaded Provenance
nucleisky-0.0.1.tar.gz 158.2 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for nucleisky 0.0.1
File Interpreter ABI Platform
nucleisky-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 300.4 kB

Release files / nucleisky-0.0.1.tar.gz

Download URL nucleisky-0.0.1.tar.gz
Size 158.2 kB
Tags Source
SHA-256 checksum
How to use checksums
a5c38127471b1a482dba5e559a7cdbcca6e66fa596783693eed62348668eb6c1
BLAKE2b-256 checksum
How to use checksums
01404003d5aab8ba848b88296917a97850fba44be565c0e6a5bf69d2b83cf796
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 30, 2026.

Transparency log

Release files / nucleisky-0.0.1-py3-none-any.whl

Download URL nucleisky-0.0.1-py3-none-any.whl
Size 142.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
703b11d8083fce6e340c7bcd2607e447b306f046d6bd32a30429cf1da3394c83
BLAKE2b-256 checksum
How to use checksums
4d9710a6ee0fd0a8e86653b7b79cbe16be8f6f80f9545b14d59e91f41fb772ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 30, 2026.

Transparency log

Security for nucleisky 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for nucleisky-0.0.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page