mwa_search scripts
The following scripts are provided as part of the mwa_search package:
LOTAAS_wrapper.py
A script that handles pulsar folding operations
usage: LOTAAS_wrapper.py [-h] [--out_dir OUT_DIR]
[-L {DEBUG,INFO,WARNING,ERROR}]
optional arguments:
-h, --help show this help message and exit
--out_dir OUT_DIR The name of the output path. Default: ./
-L {DEBUG,INFO,WARNING,ERROR}, --loglvl {DEBUG,INFO,WARNING,ERROR}
Logger verbosity level. Default: INFO
bestgridpos.py
Calculate the best position of a source from the singal to noise of several detections.
usage: bestgridpos.py [-h] [-o OBSID] [-O CALID] [-b BESTPROF_DIR]
[-p PDMP_DIR] [-r RES] [-w] [-fr FWHM_RA] [-fd FWHM_DEC]
[--orig_pointing ORIG_POINTING [ORIG_POINTING ...]]
[--label LABEL]
optional arguments:
-h, --help show this help message and exit
-o OBSID, --obsid OBSID
The observation ID of the fits file to be searched
-O CALID, --calid CALID
The calibration ID of the fits file to be searched
-b BESTPROF_DIR, --bestprof_dir BESTPROF_DIR
The directory of bestprof files of detections.
-p PDMP_DIR, --pdmp_dir PDMP_DIR
The directory of pdmp files of detections.
-r RES, --res RES The resolution of the search in degrees.
-w, --write Write out a file with the predicted poistion.
-fr FWHM_RA, --fwhm_ra FWHM_RA
Manualy give the RA FWHM in degrees instead of it
estimating it from the array phase and frequency
-fd FWHM_DEC, --fwhm_dec FWHM_DEC
Manualy give the declination FWHM in degrees instead
of it estimating it from the array phase and frequency
--orig_pointing ORIG_POINTING [ORIG_POINTING ...]
The original pointing. If used will output a file with
the original pointing and best pointing SNs.
--label LABEL Label the output predicted position.
cold_storage_mover.py
Used to put the fits files of MWA pointings into cold storage on galaxy. You must have an sshkey for hpc-hsm.pawsey.org.au
usage: cold_storage_mover.py [-h] [-w WORK_DIR] [-r] [-p POINTING_FILE]
[-o OBSID] [-d DIR_FILE]
optional arguments:
-h, --help show this help message and exit
-w WORK_DIR, --work_dir WORK_DIR
The working directory on Pawsey's HSM cold storage
that you would like to store your files in (please
make this foulder before running this script). For
example
/project/mwaops/nswainston/yogesh_low_DM_candiate/.
-r, --no_remove By default this script will remove the directory after
the file has succesfully been transfered to cold
storage. If you use this option it will NOT delete the
foulder after transfering it.
find_clustered_and_known_pulsar_candidates.py
A script designed to organise the SMART candidates and look for clustering in period and DM in adjacent beams
usage: find_clustered_and_known_pulsar_candidates.py [-h] [-o OBSID] [-g GLOB]
[-c CAND_FILE]
[-cd CDIST] [-cp CPERIOD]
[--cdm CDM] [--csn CSN]
[-sd SDIST] [-sp SPERIOD]
[--sdm SDM] [--no_plot]
[--out_file OUT_FILE]
[--out_dir OUT_DIR]
optional arguments:
-h, --help show this help message and exit
grid.py
Makes a hexogonal grid pattern around a pointing for a MWA VCS observation. grid.py -o 1166459712 -p “06:25:31.20 -36:40:48.0” -d 0.6 -l 1
usage: grid.py [-h] [-o OBSID] [-p POINTING] [--aitoff] [-f FRACTION]
[-d DEG_FWHM]
[--dec_range_fwhm DEC_RANGE_FWHM [DEC_RANGE_FWHM ...]]
[-t TYPE] [-l LOOP] [--fill FILL] [-a] [-b BEGIN] [-e END]
[--dec_range DEC_RANGE [DEC_RANGE ...]]
[--ra_range RA_RANGE [RA_RANGE ...]] [-v]
[--pulsar PULSAR [PULSAR ...]] [--label LABEL] [-n N_POINTINGS]
[--out_file_name OUT_FILE_NAME] [--add_text] [--plot_max_min]
optional arguments:
-h, --help show this help message and exit
-o OBSID, --obsid OBSID
Observation ID
-p POINTING, --pointing POINTING
Centre pointing in hh:mm:ss.ss_dd"mm'ss.ss
--aitoff Plots the output in aitoff (may make it hard to
analyise).
-f FRACTION, --fraction FRACTION
Fraction of the full width half maximum to use as the
distance between beam centres
-d DEG_FWHM, --deg_fwhm DEG_FWHM
Sets the FWHM at zenith in degrees (best to test along
dec). The script will not calculate the FWHM
--dec_range_fwhm DEC_RANGE_FWHM [DEC_RANGE_FWHM ...]
A list of FWHM and ranges in the order of: "FWHM1
decmin1 decmax1 FWHM2 decmin2 decmax2"
-t TYPE, --type TYPE Can be put in either "hex" or "square" tiling mode.
Default is hex.
-l LOOP, --loop LOOP Number of "loops" around the centre pointing the code
will calculate. Default is 1
--fill FILL Calculate the number of loops required to fill a
circle of the input radius in degrees.
-a, --all_pointings Will calculate all the pointings within the FWHM of
the observations tile beam.
-b BEGIN, --begin BEGIN
Begin time of the obs for the --all_pointings options
-e END, --end END End time of the obs for the --all_pointings options
--dec_range DEC_RANGE [DEC_RANGE ...]
Dec limits: "decmin decmax". Default -90 90
--ra_range RA_RANGE [RA_RANGE ...]
RA limits: "ramin ramax". Default 0 360
-v, --verbose_file Creates a more verbose output file with more
information than make_beam.c can handle.
--pulsar PULSAR [PULSAR ...]
A list of pulsar to mark on the plot
--label LABEL A label to put in front of the pointings.
-n N_POINTINGS, --n_pointings N_POINTINGS
Number of pointings per output file.
--out_file_name OUT_FILE_NAME
The output file name.
--add_text Adds the pointing in text for each circle on the
output plot
--plot_max_min Plots the beam size at the maximum and minimum
frequency
lfDDplan.py
Used to calculate the Dedispersion plan for low-frequency telescopes. Inspired by PRESTO’s DDplan.py.
usage: lfDDplan.py [-h] [-f CENTREFREQ] [-b BANDWIDTH] [-nf NFREQCHAN]
[-t TIMERES] [-ld LOWDM] [-hd HIGHDM] [-o OBSID]
[-m MIN_DM_STEP] [--max_DM_step MAX_DM_STEP] [-p]
[--time TIME] [--max_dms_per_job MAX_DMS_PER_JOB]
optional arguments:
-h, --help show this help message and exit
-f CENTREFREQ, --centrefreq CENTREFREQ
Centre frequency of the observation in MHz.
-b BANDWIDTH, --bandwidth BANDWIDTH
Bandwidth of the observation in MHz.
-nf NFREQCHAN, --nfreqchan NFREQCHAN
Number of frequency channels.
-t TIMERES, --timeres TIMERES
Time resolution in ms.
-ld LOWDM, --lowDM LOWDM
Lowest DM of the required range.
-hd HIGHDM, --highDM HIGHDM
Highest DM of the required range.
-o OBSID, --obsid OBSID
The MWA observation ID of an observation. Using this
command will get the require observation parameters.
-m MIN_DM_STEP, --min_DM_step MIN_DM_STEP
The minimun DM step size, default 0.02
--max_DM_step MAX_DM_STEP
The maximum DM step size, default 500.0
-p, --plot Plot the sensitivty of the DM plan
--time TIME Time in seconds to calculate the sensitivity
--max_dms_per_job MAX_DMS_PER_JOB
If Nsteps is greater than this value split it into
multiple lines. This will cause the search pipeline to
submit fewer DMs per job