Data

Tools

Indexes

Applications

Experiments

Open Source Science

skytag

Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.

https://github.com/thespacedoctor/skytag

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.

Basic Info
  • Host: GitHub
  • Owner: thespacedoctor
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 2.78 MB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created almost 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

skytag

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 (development version and main version). The code lives on github. Please report any issues you find here. If you want to contribute, pull requests 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.
  • works well in conjunction with gocart.

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.

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.

gocart

skyTag works very well in conjunction with gocart, a tool to consume GCN Kafka alert streams and convert HealPix skymaps.

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.7977905}, license = {GPL-3.0-only}, title = {{skytag. Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.}}, url = {https://zenodo.org/doi/10.5281/zenodo.7977905} }

Owner

  • Name: David Young
  • Login: thespacedoctor
  • Kind: user
  • Location: Belfast, UK
  • Company: Queen's University Belfast

Citation (CITATION.cff) 

cff-version: 1.2.0
title: skytag. Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.
message: If you use this software, please cite it as below.
authors:
- family-names: "Young"
  given-names: "David R."
  orcid: "https://orcid.org/0000-0002-1229-2499"
doi: 10.5281/zenodo.7977905
url: "https://zenodo.org/doi/10.5281/zenodo.7977905"
abstract: Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.
keywords: [astronomy]
license: GPL-3.0-only

GitHub Events

Total
  • Push event: 2
Last Year
  • Push event: 2

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 27
  • Total Committers: 1
  • Avg Commits per committer: 27.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Dave d****g@q****k 27
Committer Domains (Top 20 + Academic)
qub.ac.uk: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: 13 days
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • thespacedoctor (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 22 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
pypi.org: skytag

Annotate transient sources or galaxies with the percentage credibility region they reside within on a given HealPix sky map.

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 22 Last month
Rankings
Dependent packages count: 7.2%
Downloads: 24.2%
Average: 26.9%
Forks count: 30.5%
Dependent repos count: 33.4%
Stargazers count: 39.3%
Maintainers (1)
thespacedoctor
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • Markdown ==3.3.4
  • MarkdownSubscript *
  • docopt *
  • importlib-metadata ==4.13.0
  • jinja2 ==3.0.0
  • lxml *
  • m2r *
  • mdx_include >1.3
  • mistune <2.0.0
  • mock >4.0
  • psutil >5.7
  • pymdown-extensions >8.0
  • sphinx ==3.5.4
  • sphinx_markdown_parser master
  • sphinx_rtd_theme *
  • sphinxcontrib-mermaid *
  • unicodecsv *
setup.py pypi
  • astropy *
  • astropy-healpix *
  • fundamentals *
  • numpy *
  • pandas *
  • pyyaml *