tns_api

API to access Transient Name Server (TNS) data

Installation

It is recommended to install tns_api from pip:

pip install tns_api

or it can be installed from source in the usual way.

Usage Example

Below are some basic examples of what the user can do with this package.

Environmental Variables

First of all, you will need to set a .env file in the current directory with the following variables:

tns_id = 'YOUR_TNS_ID'
name = 'YOUR_BOT_NAME'
api_key = 'YOUR_API_KEY'

where the values for these can be obtained by creating a BOT (for mor information, check the TNS Help page).

Retrieving Properties

All the properties of an object can be obtained with a single line:

from tns_api import get_object
get_object('2004eo')

{'objname': '2004eo',
 'name_prefix': 'SN',
 'objid': 2980,
 'object_type': {'name': 'SN Ia', 'id': 3},
 'redshift': None,
 'ra': '20:32:54.190',
 'dec': '+09:55:42.71',
 'radeg': 308.22579,
 'decdeg': 9.92853,
 'radeg_err': None,
 'decdeg_err': None,
 'hostname': 'NGC 6928        ',
 'host_redshift': None,
 'internal_names': None,
 'discoverer_internal_name': None,
 'discoverydate': '2004-09-17 00:00:00.000',
 'discoverer': None,
 'reporter': None,
 'reporterid': None,
 'source': 'bot',
 'discoverymag': 17.8,
 'discmagfilter': {'id': None, 'name': None, 'family': None},
 'reporting_group': {'groupid': None, 'group_name': None},
 'discovery_data_source': {'groupid': None, 'group_name': None},
 'public': 1,
 'end_prop_period': None}

Contributing

To contribute, either open an issue or send a pull request (prefered option). You can also contact me directly (check my profile: https://github.com/temuller).

Citing TNS API

If you make use of this code, please cite it:

@software{tomas_e_muller_bravo_2023_8181824,
  author       = {{M{\"u}ller-Bravo}, Tom{\'a}s E.},
  title        = {temuller/tns\_api: First Release (for zenodo)!},
  month        = jul,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {zenodo\_version},
  doi          = {10.5281/zenodo.8181824},
  url          = {https://doi.org/10.5281/zenodo.8181824}
}