Schemas

Sky model and cab schemas are declared as YAML files under src/simms/schemas/ and used to validate/clickify CLI parameters (see Command-line interface).

simms sky model schema

info: These are the default parameter names and units for simms skymodel specifcation. But you can use your 
      own specifcation by setting the 'alias' field of the relevant parameter, then parsing your modified file 
      to the '--source-schema' option of the 'simms skysim' command. The units given via the 'units' field must
      folow the 'astropy.units' naming convention.

parameters:
  name:
    info: Source name/label
    alias: null
    units: null
    ptype: string
  ra:
    info: Right ascension
    alias: null
    units: deg
    ptype: longitude
    join: [ra_h, ra_m, ra_s]
  # The h/m/s and d/m/s fields below are sexagesimal components of ra and dec.
  # They are plain numbers; the units of the leading component (ra_h, dec_d)
  # set the scale of the joined sexagesimal value.
  ra_h:
    info: Right ascension hours (sexagesimal component)
    alias: null
    units: hourangle
    ptype: number
  ra_m:
    info: Right ascension minutes (sexagesimal component)
    alias: null
    units: null
    ptype: number
  ra_s:
    info: Right ascension seconds (sexagesimal component)
    alias: null
    units: null
    ptype: number
  dec:
    info: Declination
    alias: null
    units: deg
    ptype: latitude
    join: [dec_d, dec_m, dec_s]
  dec_d:
    info: Declination degrees (sexagesimal component)
    alias: null
    units: deg
    ptype: number
  dec_m:
    info: Declination arcminutes (sexagesimal component)
    alias: null
    units: null
    ptype: number
  dec_s:
    info: Declination arcseconds (sexagesimal component)
    alias: null
    units: null
    ptype: number
  stokes_i: 
    info: Stokes I
    alias: null
    units: Jy
    ptype: flux
    required: true
  stokes_q:
    info: Stokes Q
    alias: null
    units: Jy
    ptype: flux
  stokes_u:
    info: Stokes U
    alias: null
    units: Jy
    ptype: flux
  stokes_v:
    info: Stokes V
    alias: null
    units: Jy
    ptype: flux
  emaj:
    info: Gaussian major-axis FWHM; default units [deg]
    alias: null
    units: deg
    ptype: angle
  emin:
    info: Gaussian minor-axis FWHM; default units [deg]
    alias: null
    units: deg
    ptype: angle
  pa:
    info: Position angle; default units
    alias: null
    units: deg
    ptype: angle
  cont_reffreq:
    info: Continuum reference frequency; default units
    alias: null
    units: Hz
    ptype: frequency
  cont_coeff_1: 
    info: Spectral index term (second order term)
    alias: null
    units: null
    ptype: number
  cont_coeff_2:
    info: Spectral curvature term (third order term)
    alias: null
    units: null
    ptype: number
  cont_coeff_3:
    info: Spectral log-parabolic term (fourth order term)
    alias: null
    units: null
    ptype: number
  line_peak:
    info: Observed frequency of the line peak (line centre). Takes precedence
          over line_restfreq/line_redshift when both are given.
    alias: null
    units: Hz
    ptype: frequency
  line_width:
    info: Line FWHM in the observed frame; default units
    alias: null
    units: Hz
    ptype: frequency
  line_restfreq:
    info: Line rest frequency. Used with line_redshift to derive the observed
          line centre when line_peak is not given.
    alias: null
    units: Hz
    ptype: frequency
  line_redshift:
    info: Source redshift; shifts line_restfreq to the observed frame
          (observed centre = line_restfreq / (1 + line_redshift)). Default 0.
    alias: null
    units: null
    ptype: number
  transient_start:
    info: Beginning of transient event relative to observation start
    alias: null
    units: null
    ptype: time
  transient_period:
    info:  Total time of transient event, including ingress and egress
    alias: null
    units: s
    ptype: time
  transient_ingress:  
    info: Duration of ingress; default units
    alias: null
    units: s
    ptype: time
  transient_absorb:
    info: Maximum fractional flux decrease during the transit
    alias: null
    units: null
    ptype: number

PyBDSF sky model schema mapper (Gaussian source list; Gaul)

info: "Mapper for PyBDSF GAUL sources: maps GAUL catalogue columns to the simms sky model schema using the 'alias' fields. Use with the --mapping option of simms skysim."

parameters:
  name:
    info: Source name/label
    alias: Source_id
    units: null
    ptype: string
  ra:
    info: Right ascension
    alias: RA
    units: deg
    ptype: longitude
    required: true
  dec:
    info: Declination
    alias: DEC
    units: deg
    ptype: latitude
    required: true
  stokes_i: 
    info: Stokes I
    alias: Total_flux
    units: Jy
    ptype: flux
    required: true
  stokes_q:
    info: Stokes Q
    alias: null
    units: Jy
    ptype: flux
  stokes_u:
    info: Stokes U
    alias: null
    units: Jy
    ptype: flux
  stokes_v:
    info: Stokes V
    alias: null
    units: Jy
    ptype: flux
  emaj:
    info: Major axis; default units
    alias: DC_Maj
    units: deg
    ptype: angle
  emin:
    info: Minor axis; default units [deg]
    alias: DC_Min
    units: deg
    ptype: angle
  pa:
    info: Position angle; default units
    alias: DC_PA
    units: deg
    ptype: angle
  cont_reffreq:
    info: Continuum reference frequency; default units
    alias: null
    units: Hz
    ptype: frequency
  cont_coeff_1: 
    info: Spectral index term (second order term)
    alias: null
    units: null
    ptype: number
  cont_coeff_2:
    info: Spectral curvature term (third order term)
    alias: null
    units: null
    ptype: number
  cont_coeff_3:
    info: Spectral log-parabolic term (fourth order term)
    alias: null
    units: null
    ptype: number
  line_peak:
    info: Observed frequency of the line peak (line centre). Takes precedence
          over line_restfreq/line_redshift when both are given.
    alias: null
    units: Hz
    ptype: frequency
  line_width:
    info: Line FWHM in the observed frame; default units
    alias: null
    units: Hz
    ptype: frequency
  line_restfreq:
    info: Line rest frequency. Used with line_redshift to derive the observed
          line centre when line_peak is not given.
    alias: null
    units: Hz
    ptype: frequency
  line_redshift:
    info: Source redshift; shifts line_restfreq to the observed frame
          (observed centre = line_restfreq / (1 + line_redshift)). Default 0.
    alias: null
    units: null
    ptype: number
  transient_start:
    info: Beginning of transient event relative to observation start
    alias: null
    units: null
    ptype: time
  transient_period:
    info:  Total time of transient event, including ingress and egress
    alias: null
    units: s
    ptype: time
  transient_ingress:  
    info: Duration of ingress; default units
    alias: null
    units: s
    ptype: time
  transient_absorb:
    info: Maximum fractional flux decrease during the transit
    alias: null
    units: null
    ptype: number