Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/linters/.cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,12 @@
"pypa",
"pypi",
"MAINT",
"ASCL",
"Bibcode",
"bibtex",
"howpublished",
"adsurl",
"adsnote",
"autoclass",
"autofunction",
"automodule",
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023-2024 Yuan-Ming Hsu
Copyright (c) 2023-2025 Yuan-Ming Hsu
All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# spherimatch
[![ascl:2507.022](https://img.shields.io/badge/ascl-2507.022-blue.svg?colorB=262255)](https://ascl.net/2507.022)
[![2025ascl.soft07022H](https://img.shields.io/badge/ADS-2025ascl.soft07022H-blue.svg)](https://ui.adsabs.harvard.edu/abs/2025ascl.soft07022H/abstract)

A Python package for cross-matching and self-matching in spherical coordinates.

## Table of Contents
Expand Down Expand Up @@ -39,26 +42,31 @@ Before you start, please check out our documentation for a
[duplicate removal example](https://technic960183.github.io/spherimatch/tutorial/duplicates_removal.html).

## API Reference
The full documentation and API reference can be found [here](https://technic960183.github.io/spherimatch/index.html).
The API reference can be found in the [full documentation](https://technic960183.github.io/spherimatch/index.html).

## Contributing
If you find any bugs or potential issues, please report it directly to me (via Slack or E-mail), or start an [issue](https://github.com/technic960183/spherimatch/issues).

If you have any suggestions or feature requests, feel free to start an [issue](https://github.com/technic960183/spherimatch/issues).

## Citation
If you find `spherimatch` useful in your research, please consider citing it. Currently, we do not plan to publish a method paper for this package in the year of 2024. However, you can still cite this repository directly.
If you find `spherimatch` useful in your research, please consider citing it.

`spherimatch` is registered in the [Astrophysics Source Code Library (ASCL)](https://ascl.net/2507.022), and can be cited using its Bibcode: [`2025ascl.soft07022H`](https://ui.adsabs.harvard.edu/abs/2025ascl.soft07022H/abstract).

To cite spherimatch in your publication, please use the following BibTeX entry:
Please feel free to use your preferred citation format. For convenience, here is a BibTeX entry:
```bibtex
@misc{spherimatch,
author = {Yuan-Ming Hsu},
title = {spherimatch: A Python package for cross-matching and self-matching in spherical coordinates.},
year = {2024},
howpublished = {\url{https://github.com/technic960183/spherimatch}},
note = {Accessed: YYYY-MM}
@software{2025ascl.soft07022H,
author = {{Hsu}, Yuan-Ming},
title = "{spherimatch: Cross-matching and self-matching in spherical coordinates}",
howpublished = {Astrophysics Source Code Library, record ascl:2507.022},
year = 2025,
month = jul,
eid = {ascl:2507.022},
adsurl = {https://ui.adsabs.harvard.edu/abs/2025ascl.soft07022H},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```
Additionally, you may add a reference to `https://github.com/technic960183/spherimatch` in the footnote if suitable.
You may also include a reference to the GitHub repository `https://github.com/technic960183/spherimatch` in the footnote if appropriate.

If you publish a paper that uses `spherimatch`, please let me know. I would be happy to know how this package has been used in research.
If you publish a paper that uses `spherimatch`, feel free to let me know. I would be happy to hear how this package supports your work!
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'spherimatch'
copyright = '2024, Yuan-Ming Hsu'
copyright = '2023-2025, Yuan-Ming Hsu'
author = 'Yuan-Ming Hsu'
release = 'v0.0'

Expand Down