Welcome to vcstools’s documentation!

Contents:

The following scripts are provided as part of the vcstools package:

  • RVM_fit.py - A script that performs a least squares fit to the Rotating Vector Model

  • calibrate_vcs.py - Script for creating RTS configuration files and submitting relevant jobs in the VCS pulsar pipeline

  • checks.py - scripts to check sanity of downloads and recombine.

  • cleanup.py - Tool for cleaning up after processing MWA Pulsar Data on Galaxy

  • combine_calibrations.py - If there is no calibration observation with the correct channels, use this script to combine the result of two calibration solutions to make a new calibration solution with all the required frequency channels.

  • create_ics_psrfits.py - positional arguments: obsID Observation ID for which to create the incoherent sum PSRFITS

  • find_pulsar_in_obs.py - This code is used to list the sources within the beam of observations IDs or using –obs_for_source list all the observations for each source. The sources can be input serval ways: using a list of pulsar names (–pulsar), using a complete catalogue file of pulsars (–dl_PSRCAT) or RRATs (–RRAT and –dl_RRAT), using a compatable catalogue (–in_cat with the help of –names and –coordstype) or using a RA and DEC coordinate (–coords). The observation IDs can be input (–obsid) or gathered from a directory (–FITS_dir). The default is to search all observation IDs from http://mwa- metadata01.pawsey.org.au/metadata/ that have voltages and list every known pulsar from PSRCAT in each observation ID.

  • mwa_metadb_utils.py - Returns information on an input Obs ID

  • pabeam.py - Script to calculate the array factor required to model the tied-array beam for the MWA. This is an MPI-based simulation code and will use all available processes when run (i.e. there is no user choice in how many to use)

  • process_vcs.py - process_vcs.py is a script for processing the MWA VCS data on Galaxy in steps. It can download data from the archive, call on recombine to form course channels, run the offline correlator, make tile re-ordered and bit promoted PFB files or for a coherent beam for a given pointing.

  • prof_estimate.py - A utility file for calculating a variety of pulse profile properties

  • recombine.py - Combines raw VCS data

  • rename_corr_output.py - Script to rename the files that are produced by the offline correlator to the convention assumed by Andr Offringa’s tools.

  • reorder_chans.py - Print the coarse channel sequence as in gpubox/subband order. Make sure you have *_metafits_ppds.fits

  • rm_synthesis.py - A script that performs the RM synthesis technique

  • rts2ao.py - rts2ao.py is a tool for converting an RTS solution to an Offringa-style solution.

  • sn_flux_est.py -

  • splice-wrapper.py-label - Wraps the splice_psrfits.sh script to automate it. Should be run from the foulder containing the files.

  • submit_to_database.py - This code is used to submit pulsar detections and observation calibrations to the MWA Pulsar Database. It can calculate all need values (flux density, width, scattering) for each detection and submit them to the pulsar database without having to manually input them. It can also submit diagnostic files such as pulse profiles and calibrations. This code assumes that the observation is coherent and correlated using the RTS so please use –incoh and –andre if your observation is incoherent or correlated using Andre’s Tools respectively.

  • zapchan.py - Output the correctly formated MWA band edge channels and user-defined channels to remove for aliasing/RFI excision. If no options are given, returns an empty string.