Setup constants

This submodule sets up common constants for use, such as the allowed pulsar parameters and various URLs used for queries.

ADS_URL = 'https://ui.adsabs.harvard.edu/#abs/{}/'

The URL for the NASA ADS.

ATNF_BASE_URL = 'http://www.atnf.csiro.au/people/pulsar/psrcat/'

The ATNF pulsar catalogue base URL.

ATNF_TARBALL = 'http://www.atnf.csiro.au/people/pulsar/psrcat/downloads/psrcat_pkg.tar.gz'

The name of the tarball containing the entire catalogue database.

GC_URL = 'http://www.naic.edu/~pfreire/GCpsr.txt'

Paolo Freire’s globular cluster pulsar table URL

GLITCH_URL = 'http://www.jb.man.ac.uk/pulsar/glitches/gTable.html'

The Jodrell Bank glitch catalogue table URL.

MSP_URL = 'http://astro.phys.wvu.edu/GalacticMSPs/GalacticMSPs.txt'

Dunc Lorimer’s MSP table URL

PSR_ALL = {'A1': {'err': True, 'ref': True, 'units': 's'}, 'A12DOT': {'err': True, 'ref': True, 'units': 's s^-2'}, 'A1DOT': {'err': True, 'ref': True, 'units': 's s^-1'}, 'A1_2': {'err': True, 'ref': True, 'units': 's'}, 'A1_3': {'err': True, 'ref': True, 'units': 's'}, 'AGE': {'err': False, 'ref': False, 'units': 'yr'}, 'AGE_I': {'err': False, 'ref': False, 'units': 'yr'}, 'ASSOC': {'err': False, 'ref': False, 'units': None}, 'BINARY': {'err': False, 'ref': True, 'units': None}, 'BINCOMP': {'err': False, 'ref': True, 'units': None}, 'BNAME': {'err': False, 'ref': True, 'units': None}, 'BSURF': {'err': False, 'ref': False, 'units': 'G'}, 'BSURF_I': {'err': False, 'ref': False, 'units': 'G'}, 'B_LC': {'err': False, 'ref': False, 'units': 'G'}, 'CLK': {'err': False, 'ref': True, 'units': None}, 'DATE': {'err': False, 'ref': False, 'units': 'yr'}, 'DECJ': {'err': True, 'ref': True, 'units': None}, 'DECJD': {'err': True, 'ref': False, 'units': 'deg'}, 'DIST': {'err': False, 'ref': False, 'units': 'kpc'}, 'DIST1': {'err': False, 'ref': False, 'units': 'kpc'}, 'DIST_A': {'err': True, 'ref': True, 'units': 'kpc'}, 'DIST_AMN': {'err': True, 'ref': True, 'units': 'kpc'}, 'DIST_AMX': {'err': False, 'ref': True, 'units': 'kpc'}, 'DIST_DM': {'err': False, 'ref': True, 'units': 'kpc'}, 'DIST_DM1': {'err': False, 'ref': True, 'units': 'kpc'}, 'DM': {'err': True, 'ref': True, 'units': 'cm^-3 pc'}, 'DM1': {'err': True, 'ref': True, 'units': 'cm^-3 pc yr^-1'}, 'DM2': {'err': True, 'ref': True, 'units': 'cm^-3 pc yr^-2'}, 'DM3': {'err': True, 'ref': True, 'units': 'cm^-3 pc yr^-3'}, 'DMEPOCH': {'err': False, 'ref': True, 'units': 'd'}, 'DMSINB': {'err': False, 'ref': False, 'units': 'cm^-3 pc'}, 'DTHETA': {'err': True, 'ref': True, 'units': '1e-6'}, 'ECC': {'err': True, 'ref': True, 'units': None}, 'ECCDOT': {'err': True, 'ref': True, 'units': 's^-1'}, 'ECC_2': {'err': True, 'ref': True, 'units': None}, 'ECC_3': {'err': True, 'ref': True, 'units': None}, 'EDOT': {'err': False, 'ref': False, 'units': 'erg/s'}, 'EDOTD2': {'err': False, 'ref': False, 'units': 'erg s^-1/kpc^2'}, 'ELAT': {'err': True, 'ref': True, 'units': 'deg'}, 'ELONG': {'err': True, 'ref': True, 'units': 'deg'}, 'EPHEM': {'err': False, 'ref': True, 'units': None}, 'EPS1': {'err': True, 'ref': True, 'units': None}, 'EPS1_2': {'err': True, 'ref': True, 'units': None}, 'EPS2': {'err': True, 'ref': True, 'units': None}, 'EPS2_2': {'err': True, 'ref': True, 'units': None}, 'F0': {'err': True, 'ref': True, 'units': 'Hz'}, 'F1': {'err': True, 'ref': True, 'units': 's^-2'}, 'F2': {'err': True, 'ref': True, 'units': 's^-3'}, 'F3': {'err': True, 'ref': True, 'units': 's^-4'}, 'F4': {'err': True, 'ref': True, 'units': 's^-5'}, 'F5': {'err': True, 'ref': True, 'units': 's^-6'}, 'FB0': {'err': True, 'ref': True, 'units': 'Hz'}, 'FB1': {'err': True, 'ref': True, 'units': 'Hz s^-1'}, 'FB2': {'err': True, 'ref': True, 'units': 'Hz s^-2'}, 'GAMMA': {'err': True, 'ref': True, 'units': 's'}, 'GB': {'err': False, 'ref': False, 'units': 'deg'}, 'GL': {'err': False, 'ref': False, 'units': 'deg'}, 'GLEP': {'err': False, 'ref': False, 'units': 'd'}, 'GLF0': {'err': False, 'ref': False, 'units': 'Hz'}, 'GLF0D': {'err': False, 'ref': False, 'units': 'Hz'}, 'GLF1': {'err': False, 'ref': False, 'units': 'Hz/s'}, 'GLPH': {'err': False, 'ref': False, 'units': None}, 'GLTD': {'err': False, 'ref': False, 'units': 'd'}, 'H0_SD': {'err': False, 'ref': False, 'units': None}, 'H3': {'err': True, 'ref': True, 'units': 's'}, 'H4': {'err': True, 'ref': True, 'units': 's'}, 'JNAME': {'err': False, 'ref': True, 'units': None}, 'KIN': {'err': True, 'ref': True, 'units': 'deg'}, 'KOM': {'err': True, 'ref': True, 'units': 'deg'}, 'M2': {'err': True, 'ref': True, 'units': 'M_sun'}, 'M2_2': {'err': True, 'ref': True, 'units': 'M_sun'}, 'M2_3': {'err': True, 'ref': True, 'units': 'M_sun'}, 'MASSFN': {'err': True, 'ref': False, 'units': 'M_sun'}, 'MASS_Q': {'err': True, 'ref': True, 'units': None}, 'MEDMASS': {'err': False, 'ref': False, 'units': 'M_sun'}, 'MINMASS': {'err': False, 'ref': False, 'units': 'M_sun'}, 'MINOMDOT': {'err': False, 'ref': False, 'units': 'deg/yr'}, 'NAME': {'err': False, 'ref': True, 'units': None}, 'NGLT': {'err': False, 'ref': False, 'units': None}, 'OM': {'err': True, 'ref': True, 'units': 'deg'}, 'OM2DOT': {'err': True, 'ref': True, 'units': 'deg/yr^2'}, 'OMDOT': {'err': True, 'ref': True, 'units': 'deg/yr'}, 'OM_2': {'err': True, 'ref': True, 'units': 'deg'}, 'OM_3': {'err': True, 'ref': True, 'units': 'deg'}, 'OM_ASC': {'err': True, 'ref': True, 'units': 'deg'}, 'OSURVEY': {'err': False, 'ref': False, 'units': None}, 'P0': {'err': True, 'ref': True, 'units': 's'}, 'P1': {'err': True, 'ref': True, 'units': None}, 'P1_I': {'err': False, 'ref': False, 'units': None}, 'PB': {'err': True, 'ref': True, 'units': 'd'}, 'PBDOT': {'err': True, 'ref': True, 'units': None}, 'PB_2': {'err': True, 'ref': True, 'units': 'd'}, 'PB_3': {'err': True, 'ref': True, 'units': 'd'}, 'PEPOCH': {'err': False, 'ref': True, 'units': 'd'}, 'PMB': {'err': False, 'ref': False, 'units': 'mas/yr'}, 'PMDEC': {'err': True, 'ref': True, 'units': 'mas/yr'}, 'PMELAT': {'err': True, 'ref': True, 'units': 'mas/yr'}, 'PMELONG': {'err': True, 'ref': True, 'units': 'mas/yr'}, 'PML': {'err': False, 'ref': False, 'units': 'mas/yr'}, 'PMRA': {'err': True, 'ref': True, 'units': 'mas/yr'}, 'PMTOT': {'err': False, 'ref': False, 'units': 'mas/yr'}, 'POSEPOCH': {'err': False, 'ref': True, 'units': 'd'}, 'PSRB': {'err': False, 'ref': True, 'units': None}, 'PSRJ': {'err': False, 'ref': True, 'units': None}, 'PX': {'err': True, 'ref': True, 'units': 'mas'}, 'RAJ': {'err': True, 'ref': True, 'units': None}, 'RAJD': {'err': True, 'ref': False, 'units': 'deg'}, 'RM': {'err': True, 'ref': True, 'units': 'rad m^-2'}, 'R_LUM': {'err': False, 'ref': False, 'units': 'mJy kpc^2'}, 'R_LUM14': {'err': False, 'ref': False, 'units': 'mJy kpc^2'}, 'S100': {'err': True, 'ref': True, 'units': 'mJy'}, 'S100G': {'err': True, 'ref': True, 'units': 'mJy'}, 'S1400': {'err': True, 'ref': True, 'units': 'mJy'}, 'S150': {'err': True, 'ref': True, 'units': 'mJy'}, 'S150G': {'err': True, 'ref': True, 'units': 'mJy'}, 'S1600': {'err': True, 'ref': True, 'units': 'mJy'}, 'S200': {'err': True, 'ref': True, 'units': 'mJy'}, 'S2000': {'err': True, 'ref': True, 'units': 'mJy'}, 'S300': {'err': True, 'ref': True, 'units': 'mJy'}, 'S3000': {'err': True, 'ref': True, 'units': 'mJy'}, 'S40': {'err': True, 'ref': True, 'units': 'mJy'}, 'S400': {'err': True, 'ref': True, 'units': 'mJy'}, 'S4000': {'err': False, 'ref': True, 'units': 'mJy'}, 'S50': {'err': True, 'ref': True, 'units': 'mJy'}, 'S5000': {'err': True, 'ref': True, 'units': 'mJy'}, 'S60': {'err': True, 'ref': True, 'units': 'mJy'}, 'S600': {'err': True, 'ref': True, 'units': 'mJy'}, 'S6000': {'err': True, 'ref': True, 'units': 'mJy'}, 'S700': {'err': True, 'ref': True, 'units': 'mJy'}, 'S80': {'err': True, 'ref': True, 'units': 'mJy'}, 'S800': {'err': True, 'ref': True, 'units': 'mJy'}, 'S8000': {'err': True, 'ref': True, 'units': 'mJy'}, 'S900': {'err': True, 'ref': True, 'units': 'mJy'}, 'SI414': {'err': False, 'ref': False, 'units': None}, 'SINI': {'err': True, 'ref': True, 'units': None}, 'SINI_2': {'err': True, 'ref': True, 'units': None}, 'SINI_3': {'err': True, 'ref': True, 'units': None}, 'SPINDX': {'err': True, 'ref': True, 'units': None}, 'STIG': {'err': True, 'ref': True, 'units': None}, 'SURVEY': {'err': False, 'ref': False, 'units': None}, 'T0': {'err': True, 'ref': True, 'units': 'd'}, 'T0_2': {'err': True, 'ref': True, 'units': 'd'}, 'T0_3': {'err': True, 'ref': True, 'units': 'd'}, 'TASC': {'err': True, 'ref': True, 'units': 'd'}, 'TASC_2': {'err': True, 'ref': True, 'units': 'd'}, 'TAU_SC': {'err': True, 'ref': True, 'units': 's'}, 'TYPE': {'err': False, 'ref': False, 'units': None}, 'UNITS': {'err': False, 'ref': True, 'units': None}, 'UPRMASS': {'err': False, 'ref': False, 'units': 'M_sun'}, 'VTRANS': {'err': False, 'ref': False, 'units': 'km/s'}, 'W10': {'err': True, 'ref': True, 'units': 'ms'}, 'W50': {'err': True, 'ref': True, 'units': 'ms'}, 'XOMDOT': {'err': False, 'ref': False, 'units': 'deg/yr'}, 'XX': {'err': False, 'ref': False, 'units': 'kpc'}, 'YY': {'err': False, 'ref': False, 'units': 'kpc'}, 'ZZ': {'err': False, 'ref': False, 'units': 'kpc'}}

A dictionary of allowed pulsars parameters (e.g., name, position, distance…)

Each parameter name key gives a dictionary containing the keys:

  • ref (bool) - True if the parameter has an associated reference with it
  • err (bool) - True if the parameter has an associated error value
  • units (str) - a string with the parameters units that can be parsed by Unit

The allowed parameters and their units are given here.

PSR_ASSOC_TYPE = ['AXP', 'EXGAL', 'GC', 'GRS', 'OPT', 'PWN', 'SNR', 'XRS']

Other sources/objects associated with the pulsar.

PSR_BINARY_TYPE = ['MS', 'NS', 'CO', 'He', 'UL']

Binary companion types for use in bincomp() when setting logical conditions.

PSR_TYPE = ['AXP', 'BINARY', 'HE', 'NRAD', 'RADIO', 'RRAT', 'XINS']

Allowed pulsar types for use in type() when setting logical conditions.