Basic CLIΒΆ
These are basic CLI for P-AIRCARS pipeline.
The main CLI of P-AIRCARS is
run-mwa-paircars, which is used to run P-AIRCARS pipeline.
Click here to see parameters
P-AIRCARS data directory and docker environment is not setup yet
usage: run-mwa-paircars [-h] --workdir WORKDIR --outdir OUTDIR
[--target_metafits TARGET_METAFITS]
[--cal_datadir CAL_DATADIR]
[--cal_metafits CAL_METAFITS] [--solint SOLINT]
[--cal_uvrange CAL_UVRANGE] [--no_polcal]
[--only_amplitude] [--redo_basic_cal] [--redo_selfcal]
[--use_solarflagger] [--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]
[--no_pbcor] [--cutout_rsun CUTOUT_RSUN]
[--no_solar_mask] [--do_overlay] [--make_msplot]
[--non_solar_data] [--no_ds]
[--do_forcereset_weightflag] [--no_cal_flag]
[--no_import_model] [--no_basic_cal]
[--do_sidereal_cor] [--no_solarcenter_move]
[--no_selfcal] [--no_ap_selfcal] [--no_solar_selfcal]
[--no_applycal] [--no_apply_selfcal] [--no_imaging]
[--verbose] [--cpu_frac CPU_FRAC]
[--mem_frac MEM_FRAC] [--max_worker MAX_WORKER]
[--keep_backup] [--no_calibrated_ms]
[--no_remote_logger] [--log2term]
[--job_password JOB_PASSWORD] [--cluster]
[--port PORT] [--partition PARTITION]
[--account ACCOUNT] [--walltime WALLTIME]
target_datadir
Run P-AIRCARS for calibration and imaging of solar observations.
options:
-h, --help show this help message and exit
###################
Essential parameters
###################:
target_datadir Target measurement set directory
--workdir WORKDIR Working directory (default: None)
--outdir OUTDIR Output products directory (default: None)
--target_metafits TARGET_METAFITS
Target metafits file (default: )
--cal_datadir CAL_DATADIR
Calibrator measurement set directory (default: )
--cal_metafits CAL_METAFITS
Calibrator metafits file (default: )
###################
Advanced calibration parameters
###################:
--solint SOLINT Solution interval for calibration (e.g. 'int', '10s',
'5min', 'inf') (default: 60s)
--cal_uvrange CAL_UVRANGE
UV range to filter data for calibration (e.g.
'>100klambda', '100~10000lambda') (default: )
--no_polcal Disable polarization calibration
--only_amplitude Apply only amplitude part of gain solution from
calibrator or not
--redo_basic_cal Redo basic calibration or not
--redo_selfcal Redo self-calibration or not
--use_solarflagger Use solar flagger
###################
Advanced imaging parameters
###################:
--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.28)
--image_timeres IMAGE_TIMERES
Output image time resolution in seconds (-1 = full)
(default: 10.0)
--pol POL Stokes parameter(s) to image ('I' or '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
(default: 1.0)
--no_pbcor Do not apply primary beam correction after imaging
--cutout_rsun CUTOUT_RSUN
Field of view cutout radius in solar radii (default:
10.0)
--no_solar_mask Disable use solar disk mask during deconvolution
--do_overlay Make overlay plot on EUV images
--make_msplot Make diagnostic plots of measurement sets
###################
Advanced pipeline parameters
###################:
--non_solar_data Disable solar data mode
--no_ds Disable making solar dynamic spectra
--do_forcereset_weightflag
Force reset of weights and flags (disabled by default)
--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_solarcenter_move
Disable moving phaseceneter to solar center
--no_selfcal Disable self-calibration
--no_ap_selfcal Disable amplitude-phase self-calibration
--no_solar_selfcal Disable solar-specific self-calibration parameters
--no_applycal Disable application of basic calibration solutions
--no_apply_selfcal Disable application of self-calibration solutions
--no_imaging Disable final imaging
--verbose Verbose logs
###################
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)
--max_worker MAX_WORKER
Maximum number of workers (default: -1)
--keep_backup Keep backup of intermediate steps
--no_calibrated_ms Keep calibrated measurement sets or not
--no_remote_logger Disable remote logger
--log2term Show logs in terminal
--job_password JOB_PASSWORD
User specified job password (default: None)
--cluster Running in cluster environment
--port PORT Prefect port (default: 4260)
###################
Advanced slurm cluster settings
###################:
--partition PARTITION
Partition name (Required) (default: None)
--account ACCOUNT Account name (If your cluster requires this, you
should provide. Otherwise job can not be started)
(default: None)
--walltime WALLTIME Wall time, each slurm job can execute in maximum this
time (default: None)
To view, measurement set details, use
show-paircars-ms.
Click here to see parameters
P-AIRCARS data directory and docker environment is not setup yet
usage: show-paircars-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 P-AIRCARS jobs status, use
show-paircars-status.
Click here to see parameters
P-AIRCARS data directory and docker environment is not setup yet
####################
P-AIRCARS Job status
####################
usage: show-paircars-status [-h] [--show] [--clean_old_jobs]
[--node_name NODE_NAME]
Show P-AIRCARS jobs status.
options:
-h, --help show this help message and exit
--show Show job status
--clean_old_jobs Clean old jobs
--node_name NODE_NAME
Slurm node name (default: None)
To see jobs logs using local GUI logger, use
run-mwa-mwalogger.
Click here to see parameters
usage: run-mwa-mwalogger [-h] [--jobid JOBID] [--logdir LOGDIR]
P-AIRCARS Logger
options:
-h, --help show this help message and exit
--jobid JOBID P-AIRCARS Jobid (default: None)
--logdir LOGDIR Log direcotory (default: None)
To update P-AIRCARS data, use
init-paircars-data.
Click here to see parameters
P-AIRCARS data directory and docker environment is not setup yet
usage: init-paircars-setup [-h] [--init] [--port PORT] [--no_kill_port]
[--datadir DATADIR] [--update] [--remotelink LINK]
[--remote_password PASSWORD] [--emails EMAILS]
Initiate P-AIRCARS data
options:
-h, --help show this help message and exit
--init Initiate data
--port PORT Prefect port (default: 4260)
--no_kill_port Do not kill occupied port
--datadir DATADIR User provided data directory (default: )
--update Update existing data
--remotelink LINK Set remote log link (default: None)
--remote_password PASSWORD
Set remote log password (default: None)
--emails EMAILS Email addresses (comma seperated) to send Job ID and
password for remote logger (default: None)
To stop a P-AIRCARS job in between, use
kill-paircars-job.
Click here to see parameters
P-AIRCARS data directory and docker environment is not setup yet
usage: kill-paircars-job [-h] --jobid JOBID
Kill P-AIRCARS Job
options:
-h, --help show this help message and exit
--jobid JOBID P-AIRCARS Job ID to kill (default: None)