Metadata-Version: 2.4
Name: lsdb-crossmatch
Version: 0.2.0
Summary: Robust crossmatch algorithms implemented for use in LSDB pipelines.
Author-email: LINCC Frameworks <lincc-frameworks-team@lists.lsst.org>
License-Expression: BSD-3-Clause
Project-URL: Source Code, https://github.com/astronomy-commons/lsdb-crossmatch
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: citation-compass>=0.0.6
Requires-Dist: lsdb<0.10.0,>=0.9.0
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: nway; extra == "dev"
Provides-Extra: nway
Requires-Dist: nway; extra == "nway"
Dynamic: license-file

<img src="https://github.com/astronomy-commons/lsdb/blob/main/docs/lincc-logo.png?raw=true" width="300" height="100">

# LSDB Crossmatch

[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)

[![PyPI](https://img.shields.io/pypi/v/lsdb-crossmatch?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/lsdb-crossmatch/)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/astronomy-commons/lsdb-crossmatch/smoke-test.yml)](https://github.com/astronomy-commons/lsdb-crossmatch/actions/workflows/smoke-test.yml)
[![Codecov](https://codecov.io/gh/astronomy-commons/lsdb-crossmatch/branch/main/graph/badge.svg)](https://codecov.io/gh/astronomy-commons/lsdb-crossmatch)

This project was automatically generated using the LINCC-Frameworks 
[python-project-template](https://github.com/lincc-frameworks/python-project-template).

Robust crossmatch algorithms implemented for use in LSDB pipelines.

See related projects:

* HATS ([on GitHub](https://github.com/astronomy-commons/hats))
  ([on ReadTheDocs](https://hats.readthedocs.io/en/stable/))
* LSDB ([on GitHub](https://github.com/astronomy-commons/lsdb)) 
  ([on ReadTheDocs](https://lsdb.readthedocs.io/en/stable/))

## Citation

If you use HATS / LSDB in your work, please cite the conference proceedings: 
["Using LSDB to enable large-scale catalog distribution, cross-matching, and analytics"](https://ui.adsabs.harvard.edu/abs/2025arXiv250102103C). 

If you use Rubin Data Preview 1 (DP1) with HATS, please also cite: ["Variability-finding in Rubin Data Preview 1 with LSDB"](https://ui.adsabs.harvard.edu/abs/2025arXiv250623955M).

When using a cross-matching algorithm from another author, please cite the algorithm appropriately. This package uses [CitationCompass](https://github.com/lincc-frameworks/citation-compass) to track the annotated algorithms that are used. You can run:

```
citation_list = get_used_citations()
```

to get a list of the annotated algorithms that were used during a run. Note that CitationCompass is still experimental and relies on developers to explicitly annotate the functions. You should always double check the algorithms used.

## Acknowledgements

This project is supported by Schmidt Sciences.

This project is based upon work supported by the National Science Foundation
under Grant No. AST-2003196.

This project acknowledges support from the DIRAC Institute in the Department of 
Astronomy at the University of Washington. The DIRAC Institute is supported 
through generous gifts from the Charles and Lisa Simonyi Fund for Arts and 
Sciences, and the Washington Research Foundation.
