From 9c0d0c3cae8e68ed347140b48b1064e3de7dc0bf Mon Sep 17 00:00:00 2001 From: Yuan-Ming Hsu <48866415+technic960183@users.noreply.github.com> Date: Mon, 4 Aug 2025 17:18:38 +0800 Subject: [PATCH 1/3] Update citation and add badges This package is finally published on ASCL. --- .github/linters/.cspell.json | 4 ++++ README.md | 28 ++++++++++++++++++---------- 2 files changed, 22 insertions(+), 10 deletions(-) diff --git a/.github/linters/.cspell.json b/.github/linters/.cspell.json index a2025e6..337ad19 100644 --- a/.github/linters/.cspell.json +++ b/.github/linters/.cspell.json @@ -36,8 +36,12 @@ "pypa", "pypi", "MAINT", + "ASCL", + "Bibcode", "bibtex", "howpublished", + "adsurl", + "adsnote", "autoclass", "autofunction", "automodule", diff --git a/README.md b/README.md index 2007842..81d2fca 100644 --- a/README.md +++ b/README.md @@ -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 @@ -47,18 +50,23 @@ If you find any bugs or potential issues, please report it directly to me (via S 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! From c0d2c9bf6794f738a6b4b5046b912651bbb1ab16 Mon Sep 17 00:00:00 2001 From: Yuan-Ming Hsu <48866415+technic960183@users.noreply.github.com> Date: Mon, 4 Aug 2025 17:48:17 +0800 Subject: [PATCH 2/3] Fix `descriptive-link-text` from `markdownlint` markdownlint v0.45.0 MD059/descriptive-link-text: Link text should be descriptive [Context: "[here]"] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 81d2fca..c1a265f 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ 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). From e725c2a7e8d18760d0de0570d8bfd9088dab8f56 Mon Sep 17 00:00:00 2001 From: Yuan-Ming Hsu <48866415+technic960183@users.noreply.github.com> Date: Mon, 4 Aug 2025 17:52:12 +0800 Subject: [PATCH 3/3] Update copyright year to 2025 --- LICENSE.txt | 2 +- docs/source/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/LICENSE.txt b/LICENSE.txt index 775f930..a9d1d92 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -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 diff --git a/docs/source/conf.py b/docs/source/conf.py index b4a502e..1543218 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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'