starhash 1.0.0__py3-none-any.whl

starhash-1.0.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: starhash
+Version: 1.0.0
+Summary: Generate unique, memorable, and deterministic names for astronomical objects.
+Project-URL: Homepage, https://github.com/tkillestein/starhash
+Project-URL: Repository, https://github.com/tkillestein/starhash
+Project-URL: Issues, https://github.com/tkillestein/starhash/issues
+Author-email: Tom Killestein <tom.killestein@gmail.com>
+Maintainer-email: Tom Killestein <tom.killestein@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: astronomy,coordinates,healpix,transients
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.11
+Requires-Dist: ff3>=1.0.2
+Requires-Dist: healpy>=1.17.3
+Requires-Dist: rich-click>=1.9.4
+Description-Content-Type: text/markdown
+
+# StarHash
+
+Generate unique, memorable, and deterministic names for astronomical objects.
+
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![HEALPix](https://img.shields.io/badge/HEALPix-powered-blue)](https://healpix.jpl.nasa.gov/)
+
+## Why?
+
+Because modern astronomy is hard enough, without mixing up sequentially-generated object
+names. Assigning memorable names to objects not only minimises the chance of triggering
+precious telescope time on the wrong thing, but reduces cognitive load.
+
+Every 3 arcsecond patch of sky now has a unique 3-word combination associated with it.
+
+### Example
+
+* Instead of `SN2024cld` or `ra=237.589792 dec=+18.93895`
+* You get: `armrest-fraying-bullion`
+
+## Installation
+
+To avoid issues with dependencies, we recommend setting up a virtual environment using
+your favourite package manager. Then:c
+
+```bash
+pip install starhash
+```
+
+or with `uv`
+
+```bash
+uv add starhash
+```
+
+## Quickstart
+
+StarHash ships a basic CLI for quick queries by default
+
+```shell
+starhash get-name-from-coord --ra=321.4214 --dec=-54.21231
+```
+
+```shell
+starhash get-coord-from-name gathering-equinox-approach
+```
+
+## Development and contributing
+
+```shell
+git clone https://github.com/tkillestein/starhash.git
+```
+
+Then create the dev environment:
+
+```shell
+uv sync --all-groups --python>=3.11
+```
+
+Install the pre-commit hooks
+
+```shell
+pre-commit install
+```
+
+And you're ready to go!
+
+Before committing any changes, run `pytest` to confirm that the hashing code still
+satisfies the round-trip property.
+
+## Citation
+
+If you include StarHash in your favourite pipeline/broker/API, please cite:
+
+```bibtex
+@software{starhash,
+  author = {Tom Killestein},
+  title = {StarHash: Human-readable identifiers for astronomical coordinates},
+  year = {2026},
+  url = {https://github.com/tkillestein/starhash}
+}
+```

starhash-1.0.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+starhash/__init__.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
+starhash/core.py,sha256=z048WKJ6tXyVir6cZ2eaDXIMIUt79ECHmkf7Rtdbjac,6287
+starhash/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+starhash/data/astronames_boost.txt,sha256=npURQ1Lo5teBYY-wDyhHsTb9XlXKiGVAafk_M2FSTQw,1667
+starhash/data/combolist.txt,sha256=mWBHR7v0kxEbXGjkiVmoTZTj9IZOhj3_b1D5kVEO-1M,63595
+starhash/data/eff_largewordlist.txt,sha256=nDixUkOM8tCPhD9O_ksDWsjl9sZstbM2EyFN4lUkuOY,108847
+starhash-1.0.0.dist-info/METADATA,sha256=SbqRlcu1rrO9a8r5mQrogwZzlMP-GSSdUBNzkAOmNZk,3340
+starhash-1.0.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+starhash-1.0.0.dist-info/entry_points.txt,sha256=Xvnkt0O4UuimpdaOxSWDg8rso82Bapu5TUL4kj3MDlA,47
+starhash-1.0.0.dist-info/licenses/LICENSE,sha256=o2UzJUbM-tSY-o3C2FXSq14iljfKcuOIryHHxILz0Xk,1065
+starhash-1.0.0.dist-info/RECORD,,

starhash-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

starhash-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+starhash = starhash.core:cli

starhash-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2025 Thomas Killestein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the “Software”), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.