Basic CLIΒΆ
These are basic CLI for MeerSOLAR pipeline.
The main CLI of MeerSOLAR is
run_meersolar, which is used to run MeerSOLAR pipeline.
Click here to see parameters
usage: run_meersolar [-h] --workdir WORKDIR --outdir OUTDIR [--solint SOLINT]
[--cal_uvrange CAL_UVRANGE] [--no_polcal]
[--target_scans [TARGET_SCANS ...]]
[--freqrange FREQRANGE] [--timerange TIMERANGE]
[--image_freqres IMAGE_FREQRES]
[--image_timeres IMAGE_TIMERES] [--pol POL]
[--minuv MINUV] [--weight WEIGHT] [--robust ROBUST]
[--no_multiscale] [--clean_threshold CLEAN_THRESHOLD]
[--do_pbcor] [--no_apply_parang]
[--cutout_rsun CUTOUT_RSUN] [--no_solar_mask]
[--no_overlay] [--non_solar_data] [--non_ds]
[--do_forcereset_weightflag] [--no_noise_cal]
[--no_cal_partition] [--no_cal_flag] [--no_import_model]
[--no_basic_cal] [--do_sidereal_cor] [--no_selfcal_split]
[--no_selfcal] [--no_ap_selfcal] [--no_solar_selfcal]
[--no_target_split] [--no_applycal] [--no_apply_selfcal]
[--no_imaging] [--cpu_frac CPU_FRAC]
[--mem_frac MEM_FRAC] [--keep_backup]
[--no_remote_logger]
[--logger_alivetime LOGGER_ALIVETIME] [--n_nodes N_NODES]
msname
Run MeerSOLAR for calibration and imaging of solar observations.
options:
-h, --help show this help message and exit
###################
Essential parameters
###################:
msname Measurement set name
--workdir WORKDIR Working directory (default: None)
--outdir OUTDIR Output products directory (default: None)
###################
Advanced calibration parameters
###################:
--solint SOLINT Solution interval for calibration (e.g. 'int', '10s',
'5min', 'inf') (default: 5min)
--cal_uvrange CAL_UVRANGE
UV range to filter data for calibration (e.g.
'>100klambda', '100~10000lambda') (default: )
--no_polcal Disable polarization calibration
###################
Advanced imaging parameters
###################:
--target_scans [TARGET_SCANS ...]
List of target scans to process (space-separated, e.g.
3 5 7) (default: [])
--freqrange FREQRANGE
Frequency range in MHz to select during imaging
(comma-seperate, e.g. '100~110,130~140') (default: )
--timerange TIMERANGE
Time range to select during imaging (comma-seperated,
e.g. '2014/09/06/09:30:00~2014/09/06/09:45:00,2014/09/
06/10:30:00~2014/09/06/10:45:00') (default: )
--image_freqres IMAGE_FREQRES
Output image frequency resolution in MHz (-1 = full)
(default: -1)
--image_timeres IMAGE_TIMERES
Output image time resolution in seconds (-1 = full)
(default: -1)
--pol POL Stokes parameter(s) to image (e.g. 'I', 'XX', 'RR',
'IQUV') (default: IQUV)
--minuv MINUV Minimum baseline length (in wavelengths) to include in
imaging (default: 0)
--weight WEIGHT Imaging weighting scheme (e.g. 'briggs', 'natural',
'uniform') (default: briggs)
--robust ROBUST Robust parameter for Briggs weighting (-2 to +2)
(default: 0.0)
--no_multiscale Disable multiscale CLEAN for extended structures
--clean_threshold CLEAN_THRESHOLD
Clean threshold in sigma for final deconvolution (Note
this is not auto-mask) (default: 1.0)
--do_pbcor Apply primary beam correction after imaging
--no_apply_parang Disable parallactic angle rotation during imaging
--cutout_rsun CUTOUT_RSUN
Field of view cutout radius in solar radii (default:
2.5)
--no_solar_mask Disable use solar disk mask during deconvolution
--no_overlay Disable overlay plot on GOES SUVI after imaging
###################
Advanced pipeline parameters
###################:
--non_solar_data Disable solar data mode
--non_ds Disable making solar dynamic spectra
--do_forcereset_weightflag
Force reset of weights and flags (disabled by default)
--no_noise_cal Disable noise calibration
--no_cal_partition Disable calibrator MS partitioning
--no_cal_flag Disable initial flagging of calibrators
--no_import_model Disable model import
--no_basic_cal Disable basic gain calibration
--do_sidereal_cor Sidereal motion correction for Sun (disabled by
default)
--no_selfcal_split Disable split for self-calibration
--no_selfcal Disable self-calibration
--no_ap_selfcal Disable amplitude-phase self-calibration
--no_solar_selfcal Disable solar-specific self-calibration parameters
--no_target_split Disable target data split
--no_applycal Disable application of basic calibration solutions
--no_apply_selfcal Disable application of self-calibration solutions
--no_imaging Disable final imaging
###################
Advanced hardware resource parameters for local system or per node on HPC cluster
###################:
--cpu_frac CPU_FRAC Fraction of CPU usuage per node (default: 0.8)
--mem_frac MEM_FRAC Fraction of memory usuage per node (default: 0.8)
--keep_backup Keep backup of intermediate steps
--no_remote_logger Disable remote logger
--logger_alivetime LOGGER_ALIVETIME
Keep remote logger alive for this many hours
(Otherwise, logger will be removed after 15 minutes of
inactivity) (default: 0)
###################
Advanced HPC settings
###################:
--n_nodes N_NODES Number of compute nodes to use (0 means local cluster)
(default: 0)
To view, measurement set details, use
show_meersolar_ms.
Click here to see parameters
usage: show_meersolar_ms [-h] msname
Run listobs and show from saved file
positional arguments:
msname Path to the measurement set
options:
-h, --help show this help message and exit
To view MeerSOLAR jobs status, use
show_meersolar_status.
Click here to see parameters
usage: show_meersolar_status [-h] --show [--clean_old_jobs]
Show MeerSOLAR jobs status.
options:
-h, --help show this help message and exit
--show Show job status
--clean_old_jobs Clean old jobs
To see jobs logs using local GUI logger, use
run_meerlogger.
Click here to see parameters
usage: run_meerlogger [-h] [--jobid JOBID] [--logdir LOGDIR]
MeerSOLAR Logger
options:
-h, --help show this help message and exit
--jobid JOBID MeerSOLAR Job ID (default: None)
--logdir LOGDIR Name of log directory (default: None)
To update MeerSOLAR data, use
init_meersolar_data.
Click here to see parameters
usage: init_meersolar_data [-h] [--init] [--update] [--remotelink LINK]
[--emails EMAILS]
Initiate MeerSOLAR data
options:
-h, --help show this help message and exit
--init Initiate data
--update Update existing data
--remotelink LINK Set remote log link (default: None)
--emails EMAILS Email addresses (comma seperated) to send Job ID and
password for remote logger (default: None)
To stop a MeerSOLAR job in between, use
kill_meersolar_job.
Click here to see parameters
usage: kill_meersolar_job [-h] --jobid JOBID
Kill MeerSOLAR Job
options:
-h, --help show this help message and exit
--jobid JOBID MeerSOLAR Job ID to kill