dpp scripts

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

observation_processing_pipeline.py

Initialises and launches a pipeline to process beamformed VCS pulsar data for an entire observation

usage: observation_processing_pipeline.py [-h] [-o OBSID] [-O CALID]
                                          [--beg BEG] [--end END]
                                          [--run_type {fresh_run,rerun_existing,rerun_broken}]
                                          [-s SEARCH_RADIUS] [--offset OFFSET]
                                          [--angle_offset ANGLE_OFFSET]
                                          [--relaunch] [--keep_logs]
                                          [--label LABEL]
                                          [-L {DEBUG,INFO,WARNING,ERROR}]
                                          [--mwa_search MWA_SEARCH]
                                          [--vcstools VCSTOOLS]

optional arguments:
  -h, --help            show this help message and exit

opp_status.py

Initialises and launches a pipeline to process beamformed VCS pulsar data for an entire observation

usage: opp_status.py [-h] [-o OBSID] [-L {DEBUG,INFO,WARNING,ERROR}]

optional arguments:
  -h, --help            show this help message and exit

pulsar_processing_pipeline.py

Initialises and launches a pipeline to process beamformed VCS pulsar data for a single pulsar

usage: pulsar_processing_pipeline.py [-h] [--cfg CFG] [--reset_logs]
                                     [--fresh_run]

optional arguments:
  -h, --help    show this help message and exit

pulsars_in_fov.py

Writes a file full of all the names and pointings of sources in the FoV.

usage: pulsars_in_fov.py [-h] [-o OBSID] [-b BEGIN] [-e END] [-a] [-f FWHM]
                         [-s SEARCH_RADIUS] [--offset OFFSET]
                         [--angle_offset ANGLE_OFFSET] [-k] [-c]
                         [-n N_POINTINGS] [-L LOGLVL]

optional arguments:
  -h, --help            show this help message and exit
  -o OBSID, --obsid OBSID
                        The observation ID of the fits file to be searched
  -b BEGIN, --begin BEGIN
                        First GPS time to process [no default]
  -e END, --end END     Last GPS time to process [no default]
  -a, --all             Perform on entire observation span. Use instead of -b
                        & -e
  -f FWHM, --fwhm FWHM  FWHM of the observation in degrees. If no value given
                        the FWHM will be estimated.
  -s SEARCH_RADIUS, --search_radius SEARCH_RADIUS
                        The radius to search (create beams within) in degrees
                        to account for ionosphere. Default: 0.00001 degrees
                        (doesn't make a grid)
  --offset OFFSET       The offset to apply to all pointings in arcseconds
  --angle_offset ANGLE_OFFSET
                        The angle of the offset to apply to all pointings in
                        degrees where zero is north
  -k, --no_known_pulsars
                        Do no include known pulsars. Default: False
  -c, --no_search_cands
                        Do no include search_cands. Default: False
  -n N_POINTINGS, --n_pointings N_POINTINGS
                        Number of pointings per output file. This is used to
                        limit the size of the output pointings which is 0.007
                        TB per pointing per minute. For example an 80 mins obs
                        with 120 pointings is 67.5 TB.
  -L LOGLVL, --loglvl LOGLVL
                        Logger verbosity level. Default: INFO