| Name | spherimatch JSON |
| Version |
0.1
JSON |
| download |
| home_page | None |
| Summary | Cross-Matching and Self-Matching in Spherical Coordinates. |
| upload_time | 2024-12-28 13:58:54 |
| maintainer | None |
| docs_url | None |
| author | Yuan-Ming Hsu |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023-2024 Yuan-Ming Hsu All rights reserved. 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. |
| keywords |
astronomy
cross-matching
spherical
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
pandas
scipy
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# spherimatch
A Python package for cross-matching and self-matching in spherical coordinates.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Example Usage](#example-usage)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [Citation](#citation)
## Introduction
`spherimatch` is a Python package designed to perform cross-matching and self-matching in spherical coordinates. This is particularly useful in fields such as astrophysics, geophysics, and any domain where objects are naturally distributed on a spherical surface.
Currently, this package only support astrophysics coordinates `(Ra, Dec)` in degrees. More units and naming convention will be supported in the future.
## Features
- Efficient computation ( $O(N\log N)$ ) of matching problems in spherical coordinates.
- Friends-of-Friends (FoF) analysis in spherical coordinates.
- Duplicate removal in spherical coordinates.
- Easy integration with existing data processing packages, such as `pandas`.
## Installation
You can install `spherimatch` by cloning the codes:
```bash
git clone https://github.com/technic960183/spherimatch.git
```
pip install will be supported in the future.
Remember to set the environment variable `PYTHONPATH` (`sys.path`) to the directory where `spherimatch` is located.
See the [installation guide](https://technic960183.github.io/spherimatch/install.html) for more details.
## Example Usage
Before you start, please check out our documentation for a
[quick start](https://technic960183.github.io/spherimatch/index.html#quickstart).
- To perform **cross-matching** between two catalogs, check this
[cross-matching example](https://technic960183.github.io/spherimatch/tutorial/xmatch.html).
- To **cluster** the objects in a catalog with the Friends-of-Friends (FoF) algorithm, check this
[clustering example](https://technic960183.github.io/spherimatch/tutorial/fof.html).
- To **remove duplicates** from a catalog, check this
[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).
## 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.
To cite spherimatch in your publication, please use the following 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}
}
```
Addtionally, you may add a reference to `https://github.com/technic960183/spherimatch` in the footnote if suitable.
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "spherimatch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "astronomy, cross-matching, spherical",
"author": "Yuan-Ming Hsu",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/10/d3/1f7de0bdb01c6ebd542c7ba39e401a349e70f2dc6127fc8dc89041fa2a45/spherimatch-0.1.tar.gz",
"platform": null,
"description": "# spherimatch\nA Python package for cross-matching and self-matching in spherical coordinates.\n\n## Table of Contents\n- [Introduction](#introduction)\n- [Features](#features)\n- [Installation](#installation)\n- [Example Usage](#example-usage)\n- [API Reference](#api-reference)\n- [Contributing](#contributing)\n- [Citation](#citation)\n\n## Introduction\n`spherimatch` is a Python package designed to perform cross-matching and self-matching in spherical coordinates. This is particularly useful in fields such as astrophysics, geophysics, and any domain where objects are naturally distributed on a spherical surface.\nCurrently, this package only support astrophysics coordinates `(Ra, Dec)` in degrees. More units and naming convention will be supported in the future.\n\n## Features\n- Efficient computation ( $O(N\\log N)$ ) of matching problems in spherical coordinates.\n- Friends-of-Friends (FoF) analysis in spherical coordinates.\n- Duplicate removal in spherical coordinates.\n- Easy integration with existing data processing packages, such as `pandas`.\n\n## Installation\nYou can install `spherimatch` by cloning the codes:\n```bash\ngit clone https://github.com/technic960183/spherimatch.git\n```\n\npip install will be supported in the future.\n\nRemember to set the environment variable `PYTHONPATH` (`sys.path`) to the directory where `spherimatch` is located.\nSee the [installation guide](https://technic960183.github.io/spherimatch/install.html) for more details.\n\n## Example Usage\nBefore you start, please check out our documentation for a\n[quick start](https://technic960183.github.io/spherimatch/index.html#quickstart).\n\n- To perform **cross-matching** between two catalogs, check this\n [cross-matching example](https://technic960183.github.io/spherimatch/tutorial/xmatch.html).\n- To **cluster** the objects in a catalog with the Friends-of-Friends (FoF) algorithm, check this\n [clustering example](https://technic960183.github.io/spherimatch/tutorial/fof.html).\n- To **remove duplicates** from a catalog, check this\n [duplicate removal example](https://technic960183.github.io/spherimatch/tutorial/duplicates_removal.html).\n\n## API Reference\nThe full documentation and API reference can be found [here](https://technic960183.github.io/spherimatch/index.html).\n\n## Contributing\nIf 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).\n\nIf you have any suggestions or feature requests, feel free to start an [issue](https://github.com/technic960183/spherimatch/issues).\n\n## Citation\nIf 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.\n\nTo cite spherimatch in your publication, please use the following BibTeX entry:\n```bibtex\n@misc{spherimatch,\n author = {Yuan-Ming Hsu},\n title = {spherimatch: A Python package for cross-matching and self-matching in spherical coordinates.},\n year = {2024},\n howpublished = {\\url{https://github.com/technic960183/spherimatch}},\n note = {Accessed: YYYY-MM}\n}\n```\nAddtionally, you may add a reference to `https://github.com/technic960183/spherimatch` in the footnote if suitable.\n\nIf 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.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023-2024 Yuan-Ming Hsu All rights reserved. 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.",
"summary": "Cross-Matching and Self-Matching in Spherical Coordinates.",
"version": "0.1",
"project_urls": {
"Bug Tracker": "https://github.com/technic960183/spherimatch/issues",
"Documentation": "https://technic960183.github.io/spherimatch/",
"Homepage": "https://github.com/technic960183/spherimatch/",
"Repository": "https://github.com/technic960183/spherimatch.git"
},
"split_keywords": [
"astronomy",
" cross-matching",
" spherical"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27fa4b436733e11d168554c26bf7c12f769087f54f706f170dde65bb253cfd7b",
"md5": "cfd588bf76db21e04396b69fd77df5f0",
"sha256": "7a8fff97cca262d60610464f0fcf010554a60ee138d086eea5f102af42d8291b"
},
"downloads": -1,
"filename": "spherimatch-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cfd588bf76db21e04396b69fd77df5f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 21905,
"upload_time": "2024-12-28T13:58:52",
"upload_time_iso_8601": "2024-12-28T13:58:52.615202Z",
"url": "https://files.pythonhosted.org/packages/27/fa/4b436733e11d168554c26bf7c12f769087f54f706f170dde65bb253cfd7b/spherimatch-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10d31f7de0bdb01c6ebd542c7ba39e401a349e70f2dc6127fc8dc89041fa2a45",
"md5": "a1c05a7e65c3ae3bf94b7adcfea8950f",
"sha256": "d68f6a324ac2183ac8314cc12cdb69d8fb11e1860339b91b91eaf51731248cc5"
},
"downloads": -1,
"filename": "spherimatch-0.1.tar.gz",
"has_sig": false,
"md5_digest": "a1c05a7e65c3ae3bf94b7adcfea8950f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 26189,
"upload_time": "2024-12-28T13:58:54",
"upload_time_iso_8601": "2024-12-28T13:58:54.677282Z",
"url": "https://files.pythonhosted.org/packages/10/d3/1f7de0bdb01c6ebd542c7ba39e401a349e70f2dc6127fc8dc89041fa2a45/spherimatch-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-28 13:58:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "technic960183",
"github_project": "spherimatch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "scipy",
"specs": []
}
],
"lcname": "spherimatch"
}
