_images/SkySegmentor_logo_large_white.jpg _images/SkySegmentor_logo_large_black.jpg

Python Tests Python Version Support Version PyPI version Documentation Status GitHub repository License: MIT Code style: black

Contents

Introduction

SkySegmentor is a python package for dividing points or maps (in HEALPix format) on the celestial sphere into equal-sized segments. It employs a sequential binary space partitioning scheme – a generalization of the k-d tree algorithm – that supports segmentation of arbitrarily shaped sky regions. By design, all partitions are approximately equal in area, with discrepancies no larger than the HEALPix pixel scale.

Dependencies

  • numpy – versions: >=1.22,<1.27

  • healpy – versions: >=1.15.0

Installation

Pip Installation

pip install skysegmentor

From the source

Clone the repository

git clone https://github.com/knaidoo29/SkySegmentor.git
cd SkySegmentor

and install by running

pip install . [--user]

Tutorials

API

Citing

If you use SkySegmentor in a publication please cite our paper:

and include a link to the SkySegmentor documentation page: https://skysegmentor.readthedocs.io/

Support

If you have any issues with the code or want to suggest ways to improve it please open a new issue (here) or (if you don’t have a github account) email krishna.naidoo.11@ucl.ac.uk.