| Name | skytag JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | https://github.com/thespacedoctor/skytag |
| Summary | Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map. |
| upload_time | 2023-05-30 09:35:08 |
| maintainer | |
| docs_url | None |
| author | David Young |
| requires_python | |
| license | MIT |
| keywords |
astronomy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# skytag
[](https://zenodo.org/badge/latestdoi/633485720)
<!-- INFO BADGES -->
[](https://pypi.org/project/skytag/)
[](https://pypi.org/project/skytag/)
[](https://anaconda.org/conda-forge/skytag)
[](https://pepy.tech/project/skytag)
[](https://github.com/thespacedoctor/skytag)
<!-- STATUS BADGES -->
[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/skytag/activity?branch=main)
[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/skytag/activity?branch=develop)
[](https://raw.githack.com/thespacedoctor/skytag/main/htmlcov/index.html)
[](https://skytag.readthedocs.io/en/main/)
[](https://github.com/thespacedoctor/skytag/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+)
*Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.*.
Documentation for skytag is hosted by [Read the Docs](https://skytag.readthedocs.io/en/main/) ([development version](https://skytag.readthedocs.io/en/develop/) and [main version](https://skytag.readthedocs.io/en/main/)). The code lives on [github](https://github.com/thespacedoctor/skytag). Please report any issues you find [here](https://github.com/thespacedoctor/skytag/issues). If you want to contribute, [pull requests](https://github.com/thespacedoctor/skytag/pulls) are welcomed!
true
## Features
- A command-line tool to report the credibility region a sky-location is found within on a HealPix skymap.
- Providing a MJD will also return the time since the map event.
- A python interface to provide the same functionality reported above, but can handle large lists of sky-locations or transient events.
## Installation
The easiest way to install skytag is to use `conda`:
``` bash
conda create -n skytag python=3.11 pip skytag -c conda-forge
conda activate skytag
```
To upgrade to the latest version of skytag use the command:
``` bash
conda upgrade skytag -c conda-forge
```
It is also possible to install via pip if required:
``` bash
pip install skytag
```
To check installation was successful run `skytag -v`. This should return the version number of the install.
## Command-Line
Here is the command-line usage:
```bash
Usage:
skytag <ra> <dec> <mapPath>
skytag <ra> <dec> <mjd> <mapPath>
```
If you need an example skymap, [download one from here](https://github.com/thespacedoctor/skytag/raw/main/skytag/commonutils/tests/input/bayestar.multiorder.fits).
For example, to find the probability of the location RA=170.343532, Dec=-40.532255 then run:
```bash
skytag 170.343532 -40.532255 bayestar.multiorder.fits
```
This returns:
> This location is found in the 74.55 credibility region of the map.
If you also supply an MJD:
```bash
skytag 170.343532 -40.532255 60065.2232 bayestar.multiorder.fits
```
We get:
> This transient is found in the 74.55 credibility region, and occurred 2.85564 days after the map event.
Finally, we can request the localised event distance for this specific sky-position be returned:
```bash
skytag -d 170.343532 -40.532255 bayestar.multiorder.fits
```
> This transient is found in the 74.55% credibility region. At this sky-position the map event is localised to a distance of 75.03 (±19.72) Mpc.
## Python API
To use skytag in your own Python code, [see here](_autosummary/skytag.commonutils.prob_at_location.html#skytag.commonutils.prob_at_location).
## How to cite skytag
If you use `skytag` in your work, please cite using the following BibTeX entry:
```bibtex
@software{Young_skytag,
author = {Young, David R.},
doi = {10.5281/zenodo.7977906},
license = {GPL-3.0-only},
title = {{skytag}},
url = {https://github.com/thespacedoctor/skytag}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/thespacedoctor/skytag",
"name": "skytag",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "astronomy",
"author": "David Young",
"author_email": "d.r.young@qub.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/6a/06/cfcc56f07984a297e56e670d44ce58127738883b1a34201acb45ef0242ee/skytag-0.3.1.tar.gz",
"platform": null,
"description": "# skytag\n\n[](https://zenodo.org/badge/latestdoi/633485720) \n\n<!-- INFO BADGES --> \n\n[](https://pypi.org/project/skytag/)\n[](https://pypi.org/project/skytag/)\n[](https://anaconda.org/conda-forge/skytag)\n[](https://pepy.tech/project/skytag)\n[](https://github.com/thespacedoctor/skytag)\n\n<!-- STATUS BADGES --> \n\n[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/skytag/activity?branch=main)\n[](https://soxs-eso-data.org/ci/blue/organizations/jenkins/skytag/activity?branch=develop)\n[](https://raw.githack.com/thespacedoctor/skytag/main/htmlcov/index.html)\n[](https://skytag.readthedocs.io/en/main/)\n[](https://github.com/thespacedoctor/skytag/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+bug%22+) \n\n*Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.*.\n\nDocumentation for skytag is hosted by [Read the Docs](https://skytag.readthedocs.io/en/main/) ([development version](https://skytag.readthedocs.io/en/develop/) and [main version](https://skytag.readthedocs.io/en/main/)). The code lives on [github](https://github.com/thespacedoctor/skytag). Please report any issues you find [here](https://github.com/thespacedoctor/skytag/issues). If you want to contribute, [pull requests](https://github.com/thespacedoctor/skytag/pulls) are welcomed! \ntrue\n\n## Features\n\n- A command-line tool to report the credibility region a sky-location is found within on a HealPix skymap. \n- Providing a MJD will also return the time since the map event. \n- A python interface to provide the same functionality reported above, but can handle large lists of sky-locations or transient events. \n\n## Installation\n\nThe easiest way to install skytag is to use `conda`:\n\n``` bash\nconda create -n skytag python=3.11 pip skytag -c conda-forge\nconda activate skytag\n```\n\nTo upgrade to the latest version of skytag use the command:\n\n``` bash\nconda upgrade skytag -c conda-forge\n```\n\nIt is also possible to install via pip if required:\n\n``` bash\npip install skytag\n```\n\nTo check installation was successful run `skytag -v`. This should return the version number of the install.\n\n## Command-Line \n\nHere is the command-line usage:\n\n```bash \nUsage:\n skytag <ra> <dec> <mapPath>\n skytag <ra> <dec> <mjd> <mapPath>\n```\n\nIf you need an example skymap, [download one from here](https://github.com/thespacedoctor/skytag/raw/main/skytag/commonutils/tests/input/bayestar.multiorder.fits).\n\nFor example, to find the probability of the location RA=170.343532, Dec=-40.532255 then run:\n\n```bash \nskytag 170.343532 -40.532255 bayestar.multiorder.fits\n```\n\nThis returns:\n\n> This location is found in the 74.55 credibility region of the map.\n\nIf you also supply an MJD:\n\n```bash \nskytag 170.343532 -40.532255 60065.2232 bayestar.multiorder.fits\n```\n\nWe get:\n\n> This transient is found in the 74.55 credibility region, and occurred 2.85564 days after the map event.\n\nFinally, we can request the localised event distance for this specific sky-position be returned:\n\n```bash \nskytag -d 170.343532 -40.532255 bayestar.multiorder.fits\n```\n\n> This transient is found in the 74.55% credibility region. At this sky-position the map event is localised to a distance of 75.03 (\u00b119.72) Mpc.\n\n## Python API\n\nTo use skytag in your own Python code, [see here](_autosummary/skytag.commonutils.prob_at_location.html#skytag.commonutils.prob_at_location).\n\n## How to cite skytag\n\nIf you use `skytag` in your work, please cite using the following BibTeX entry: \n\n```bibtex\n@software{Young_skytag,\nauthor = {Young, David R.},\ndoi = {10.5281/zenodo.7977906},\nlicense = {GPL-3.0-only},\ntitle = {{skytag}},\nurl = {https://github.com/thespacedoctor/skytag}\n}\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.",
"version": "0.3.1",
"project_urls": {
"Download": "https://github.com/thespacedoctor/skytag/archive/v0.3.1.zip",
"Homepage": "https://github.com/thespacedoctor/skytag"
},
"split_keywords": [
"astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3cba59dd125346816eab2fa94531fff06f5913d270a79976d0510f64958fb11f",
"md5": "35cec57806bfa78c3657e142f400366b",
"sha256": "d5838e6b580b025bc7a7adb9af96c634793599d66b1950017467a02671bee19a"
},
"downloads": -1,
"filename": "skytag-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "35cec57806bfa78c3657e142f400366b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28179,
"upload_time": "2023-05-30T09:35:12",
"upload_time_iso_8601": "2023-05-30T09:35:12.525120Z",
"url": "https://files.pythonhosted.org/packages/3c/ba/59dd125346816eab2fa94531fff06f5913d270a79976d0510f64958fb11f/skytag-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6a06cfcc56f07984a297e56e670d44ce58127738883b1a34201acb45ef0242ee",
"md5": "4800935f4586b08ed31c2458cd9586e9",
"sha256": "c216eed456082e0271f71a9fa6c0b194d0507b580f002bf0ffcc799931e6eac4"
},
"downloads": -1,
"filename": "skytag-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "4800935f4586b08ed31c2458cd9586e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27264,
"upload_time": "2023-05-30T09:35:08",
"upload_time_iso_8601": "2023-05-30T09:35:08.937065Z",
"url": "https://files.pythonhosted.org/packages/6a/06/cfcc56f07984a297e56e670d44ce58127738883b1a34201acb45ef0242ee/skytag-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-30 09:35:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thespacedoctor",
"github_project": "skytag",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "skytag"
}
