catsHTM-py
==========

catsHTM-py is a modernized Python fork of catsHTM, distributed under the
Apache License, Version 2.0 (see LICENSE.txt).


Original work
-------------

Copyright 2018 Eran O. Ofek and Maayane T. Soumagnac

catsHTM provides fast access and cross-matching of large astronomical catalogs
stored in the HDF5/HTM format. The algorithm and the HDF5/HTM catalog format were
designed by Eran O. Ofek as part of the MATLAB Astronomy & Astrophysics Toolbox
(Ofek 2014; ascl.soft 07005). The Python implementation was written by
Maayane T. Soumagnac (https://github.com/maayane/catsHTM). The format and package
are described in Soumagnac & Ofek (2018), https://arxiv.org/abs/1805.02666.


This fork
---------

Copyright 2026 the catsHTM-py contributors

The modernization to catsHTM-py was led by Omer Oreg (@sarhatabaot), who
maintains and publishes the fork. catsHTM-py
(https://github.com/sarhatabaot/catsHTM) modernizes the Python package: packaging
on uv, a pluggable catalog registry, on-demand and bulk data download, a split
module layout, a test suite, and self-hosted documentation. It retains and builds
on the original algorithm and HDF5/HTM format by Ofek and the Python port by
Soumagnac.


Citation & acknowledgments
--------------------------

If you use this tool or the catalogs, please cite Soumagnac & Ofek (2018) and
follow the per-catalog acknowledgment guidance linked from the README.
