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

Installation

The easiest way to install skytag is to use conda:

conda create -n skytag python=3.9 pip skytag -c conda-forge
conda activate skytag

To upgrade to the latest version of skytag use the command:

conda upgrade skytag -c conda-forge

It is also possible to install via pip if required:

pip install skytag

Or you can clone the github repo and install from a local version of the code:

git clone git@github.com:thespacedoctor/skytag.git
cd skytag
python setup.py install

To check installation was successful run skytag -v. This should return the version number of the install.

Initialising skytag

Before using skytag you need to use the init command to generate a user settings file. Running the following creates a yaml settings file in your home folder under ~/.config/skytag/skytag.yaml:

skytag init

The file is initially populated with skytag's default settings which can be adjusted to your preference.

If at any point the user settings file becomes corrupted or you just want to start afresh, simply trash the skytag.yaml file and rerun skytag init.

You are now ready to start using skytag.