Full Settings Catalog¶
This chapter documents all PipelineConfig keys with practical TOML and CLI examples.
Use it as an operator handbook when tuning large configuration files.
Example conventions¶
TOML examples are single-key snippets for clarity.
CLI examples use
--set key=value.Paths are illustrative; adapt to your environment.
Core pipeline¶
home_dirType:
PathDefault:<required>Meaning: Root of the data repository containing pulsar folders. Example TOML:home_dir = "/data/epta"
Example CLI:
pleb --config pipeline.toml --set home_dir="/data/epta"
singularity_imageType:
PathDefault:<required>Meaning: Singularity/Apptainer image with tempo2. Example TOML:singularity_image = "/images/tempo2.sif"
Example CLI:
pleb --config pipeline.toml --set singularity_image="/images/tempo2.sif"
dataset_nameType:
Optional[str]Default:NoneMeaning: Dataset name or path (seeresolved()). Example TOML:dataset_name = "DR3full"
Example CLI:
pleb --config pipeline.toml --set dataset_name="DR3full"
results_dirType:
PathDefault:Path('.')Meaning: Output directory for pipeline reports. Example TOML:results_dir = "results"
Example CLI:
pleb --config pipeline.toml --set results_dir="results"
branchesType:
List[str]Default:['main', 'EPTA']Meaning: Git branches to run/compare. Example TOML:branches = ["main","raw_ingest"]
Example CLI:
pleb --config pipeline.toml --set branches=["main","raw_ingest"]
reference_branchType:
strDefault:'main'Meaning: Branch used as change-report reference. Example TOML:reference_branch = "main"
Example CLI:
pleb --config pipeline.toml --set reference_branch="main"
pulsarsType:
PulsarSelectionDefault:'ALL'Meaning: “ALL” or an explicit list of pulsar names. Example TOML:pulsars = ["J1713+0747","J1022+1001"]
Example CLI:
pleb --config pipeline.toml --set pulsars=["J1713+0747","J1022+1001"]
outdir_nameType:
Optional[str]Default:NoneMeaning: Optional output subdirectory name. Example TOML:outdir_name = "run_pqc_balanced"
Example CLI:
pleb --config pipeline.toml --set outdir_name="run_pqc_balanced"
cleanup_output_treeType:
boolDefault:TrueMeaning: Pipeline setting. Example TOML:cleanup_output_tree = false
Example CLI:
pleb --config pipeline.toml --set cleanup_output_tree=false
cleanup_work_dirType:
boolDefault:FalseMeaning: Pipeline setting. Example TOML:cleanup_work_dir = true
Example CLI:
pleb --config pipeline.toml --set cleanup_work_dir=true
epochType:
strDefault:'55000'Meaning: Tempo2 epoch used for fitting. Example TOML:epoch = "55000"
Example CLI:
pleb --config pipeline.toml --set epoch="55000"
force_rerunType:
boolDefault:FalseMeaning: Re-run tempo2 even if outputs exist. Example TOML:force_rerun = true
Example CLI:
pleb --config pipeline.toml --set force_rerun=true
jobsType:
intDefault:1Meaning: Parallel workers per branch. Example TOML:jobs = 8
Example CLI:
pleb --config pipeline.toml --set jobs=8
run_tempo2Type:
boolDefault:TrueMeaning: Whether to run tempo2. Example TOML:run_tempo2 = false
Example CLI:
pleb --config pipeline.toml --set run_tempo2=false
make_toa_coverage_plotsType:
boolDefault:TrueMeaning: Generate coverage plots. Example TOML:make_toa_coverage_plots = false
Example CLI:
pleb --config pipeline.toml --set make_toa_coverage_plots=false
make_change_reportsType:
boolDefault:TrueMeaning: Generate change reports. Example TOML:make_change_reports = false
Example CLI:
pleb --config pipeline.toml --set make_change_reports=false
make_covariance_heatmapsType:
boolDefault:TrueMeaning: Generate covariance heatmaps. Example TOML:make_covariance_heatmaps = false
Example CLI:
pleb --config pipeline.toml --set make_covariance_heatmaps=false
make_residual_plotsType:
boolDefault:TrueMeaning: Generate residual plots. Example TOML:make_residual_plots = false
Example CLI:
pleb --config pipeline.toml --set make_residual_plots=false
make_outlier_reportsType:
boolDefault:TrueMeaning: Generate outlier tables. Example TOML:make_outlier_reports = false
Example CLI:
pleb --config pipeline.toml --set make_outlier_reports=false
make_plotsType:
Optional[bool]Default:NoneMeaning: Convenience toggle to disable all plotting outputs. Example TOML:make_plots = true
Example CLI:
pleb --config pipeline.toml --set make_plots=true
make_reportsType:
Optional[bool]Default:NoneMeaning: Convenience toggle to disable report outputs. Example TOML:make_reports = true
Example CLI:
pleb --config pipeline.toml --set make_reports=true
make_covmatType:
Optional[bool]Default:NoneMeaning: Convenience toggle to control covariance heatmaps. Example TOML:make_covmat = true
Example CLI:
pleb --config pipeline.toml --set make_covmat=true
testing_modeType:
boolDefault:FalseMeaning: If True, skip change reports (useful for CI). Example TOML:testing_mode = true
Example CLI:
pleb --config pipeline.toml --set testing_mode=true
run_pqcType:
boolDefault:FalseMeaning: Enable optional pqc stage. Example TOML:run_pqc = true
Example CLI:
pleb --config pipeline.toml --set run_pqc=true
qc_reportType:
boolDefault:FalseMeaning: Generate pqc report artifacts after the run. Example TOML:qc_report = true
Example CLI:
pleb --config pipeline.toml --set qc_report=true
run_fix_datasetType:
boolDefault:FalseMeaning: Enable FixDataset stage. Example TOML:run_fix_dataset = true
Example CLI:
pleb --config pipeline.toml --set run_fix_dataset=true
make_binary_analysisType:
boolDefault:FalseMeaning: Enable binary analysis table. Example TOML:make_binary_analysis = true
Example CLI:
pleb --config pipeline.toml --set make_binary_analysis=true
PQC detector settings¶
pqc_backend_colType:
strDefault:'group'Meaning: Backend grouping column for pqc. Example TOML:pqc_backend_col = "sys"
Example CLI:
pleb --config pipeline.toml --set pqc_backend_col="sys"
pqc_drop_unmatchedType:
boolDefault:FalseMeaning: Drop unmatched TOAs in pqc. Example TOML:pqc_drop_unmatched = true
Example CLI:
pleb --config pipeline.toml --set pqc_drop_unmatched=true
pqc_merge_tol_secondsType:
floatDefault:2.0Meaning: Merge tolerance in seconds for pqc. Example TOML:pqc_merge_tol_seconds = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_merge_tol_seconds=1.0
pqc_tau_corr_minutesType:
floatDefault:30.0Meaning: OU correlation time for pqc. Example TOML:pqc_tau_corr_minutes = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_tau_corr_minutes=1.0
pqc_fdr_qType:
floatDefault:0.01Meaning: False discovery rate for pqc. Example TOML:pqc_fdr_q = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_fdr_q=1.0
pqc_mark_only_worst_per_dayType:
boolDefault:TrueMeaning: Mark only worst TOA per day. Example TOML:pqc_mark_only_worst_per_day = false
Example CLI:
pleb --config pipeline.toml --set pqc_mark_only_worst_per_day=false
pqc_tau_rec_daysType:
floatDefault:7.0Meaning: Recovery time for transient scan. Example TOML:pqc_tau_rec_days = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_tau_rec_days=1.0
pqc_window_multType:
floatDefault:5.0Meaning: Window multiplier for transient scan. Example TOML:pqc_window_mult = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_window_mult=1.0
pqc_min_pointsType:
intDefault:6Meaning: Minimum points for transient scan. Example TOML:pqc_min_points = 4
Example CLI:
pleb --config pipeline.toml --set pqc_min_points=4
pqc_delta_chi2_threshType:
floatDefault:25.0Meaning: Delta-chi2 threshold for transients. Example TOML:pqc_delta_chi2_thresh = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_delta_chi2_thresh=1.0
pqc_exp_dip_min_duration_daysType:
floatDefault:21.0Meaning: Minimum duration (days) for exp dips. Example TOML:pqc_exp_dip_min_duration_days = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_exp_dip_min_duration_days=1.0
pqc_step_enabledType:
boolDefault:TrueMeaning: PQC detector/feature threshold. Example TOML:pqc_step_enabled = false
Example CLI:
pleb --config pipeline.toml --set pqc_step_enabled=false
pqc_step_min_pointsType:
intDefault:20Meaning: PQC detector/feature threshold. Example TOML:pqc_step_min_points = 4
Example CLI:
pleb --config pipeline.toml --set pqc_step_min_points=4
pqc_step_delta_chi2_threshType:
floatDefault:25.0Meaning: PQC detector/feature threshold. Example TOML:pqc_step_delta_chi2_thresh = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_step_delta_chi2_thresh=1.0
pqc_step_scopeType:
strDefault:'both'Meaning: PQC detector/feature threshold. Example TOML:pqc_step_scope = "both"
Example CLI:
pleb --config pipeline.toml --set pqc_step_scope="both"
pqc_dm_step_enabledType:
boolDefault:TrueMeaning: PQC detector/feature threshold. Example TOML:pqc_dm_step_enabled = false
Example CLI:
pleb --config pipeline.toml --set pqc_dm_step_enabled=false
pqc_dm_step_min_pointsType:
intDefault:20Meaning: PQC detector/feature threshold. Example TOML:pqc_dm_step_min_points = 4
Example CLI:
pleb --config pipeline.toml --set pqc_dm_step_min_points=4
pqc_dm_step_delta_chi2_threshType:
floatDefault:25.0Meaning: PQC detector/feature threshold. Example TOML:pqc_dm_step_delta_chi2_thresh = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_dm_step_delta_chi2_thresh=1.0
pqc_dm_step_scopeType:
strDefault:'both'Meaning: PQC detector/feature threshold. Example TOML:pqc_dm_step_scope = "both"
Example CLI:
pleb --config pipeline.toml --set pqc_dm_step_scope="both"
pqc_robust_enabledType:
boolDefault:TrueMeaning: PQC detector/feature threshold. Example TOML:pqc_robust_enabled = false
Example CLI:
pleb --config pipeline.toml --set pqc_robust_enabled=false
pqc_robust_z_threshType:
floatDefault:5.0Meaning: PQC detector/feature threshold. Example TOML:pqc_robust_z_thresh = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_robust_z_thresh=1.0
pqc_robust_scopeType:
strDefault:'both'Meaning: PQC detector/feature threshold. Example TOML:pqc_robust_scope = "backend"
Example CLI:
pleb --config pipeline.toml --set pqc_robust_scope="backend"
pqc_add_orbital_phaseType:
boolDefault:TrueMeaning: Add orbital-phase feature. Example TOML:pqc_add_orbital_phase = false
Example CLI:
pleb --config pipeline.toml --set pqc_add_orbital_phase=false
pqc_add_solar_elongationType:
boolDefault:TrueMeaning: Add solar elongation feature. Example TOML:pqc_add_solar_elongation = false
Example CLI:
pleb --config pipeline.toml --set pqc_add_solar_elongation=false
pqc_add_elevationType:
boolDefault:FalseMeaning: Add elevation feature. Example TOML:pqc_add_elevation = true
Example CLI:
pleb --config pipeline.toml --set pqc_add_elevation=true
pqc_add_airmassType:
boolDefault:FalseMeaning: Add airmass feature. Example TOML:pqc_add_airmass = true
Example CLI:
pleb --config pipeline.toml --set pqc_add_airmass=true
pqc_add_parallactic_angleType:
boolDefault:FalseMeaning: Add parallactic-angle feature. Example TOML:pqc_add_parallactic_angle = true
Example CLI:
pleb --config pipeline.toml --set pqc_add_parallactic_angle=true
pqc_add_freq_binType:
boolDefault:FalseMeaning: Add frequency-bin feature. Example TOML:pqc_add_freq_bin = true
Example CLI:
pleb --config pipeline.toml --set pqc_add_freq_bin=true
pqc_freq_binsType:
intDefault:8Meaning: Number of frequency bins if enabled. Example TOML:pqc_freq_bins = 4
Example CLI:
pleb --config pipeline.toml --set pqc_freq_bins=4
pqc_observatory_pathType:
Optional[str]Default:NoneMeaning: Optional observatory file path. Example TOML:pqc_observatory_path = "value"
Example CLI:
pleb --config pipeline.toml --set pqc_observatory_path="value"
pqc_structure_modeType:
strDefault:'none'Meaning: Feature-structure mode (none/detrend/test/both). Example TOML:pqc_structure_mode = "both"
Example CLI:
pleb --config pipeline.toml --set pqc_structure_mode="both"
pqc_structure_detrend_featuresType:
Optional[List[str]]Default:['solar_elongation_deg', 'orbital_phase']Meaning: Features to detrend against. Example TOML:pqc_structure_detrend_features = ["solar_elongation_deg","orbital_phase"]
Example CLI:
pleb --config pipeline.toml --set pqc_structure_detrend_features=["solar_elongation_deg","orbital_phase"]
pqc_structure_test_featuresType:
Optional[List[str]]Default:['solar_elongation_deg', 'orbital_phase']Meaning: Features to test for structure. Example TOML:pqc_structure_test_features = ["solar_elongation_deg","orbital_phase"]
Example CLI:
pleb --config pipeline.toml --set pqc_structure_test_features=["solar_elongation_deg","orbital_phase"]
pqc_structure_nbinsType:
intDefault:12Meaning: Bin count for structure tests. Example TOML:pqc_structure_nbins = 4
Example CLI:
pleb --config pipeline.toml --set pqc_structure_nbins=4
pqc_structure_min_per_binType:
intDefault:3Meaning: Minimum points per bin. Example TOML:pqc_structure_min_per_bin = 4
Example CLI:
pleb --config pipeline.toml --set pqc_structure_min_per_bin=4
pqc_structure_p_threshType:
floatDefault:0.01Meaning: p-value threshold for structure detection. Example TOML:pqc_structure_p_thresh = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_structure_p_thresh=1.0
pqc_structure_circular_featuresType:
Optional[List[str]]Default:['orbital_phase']Meaning: Circular features in [0,1). Example TOML:pqc_structure_circular_features = ["orbital_phase"]
Example CLI:
pleb --config pipeline.toml --set pqc_structure_circular_features=["orbital_phase"]
pqc_structure_group_colsType:
Optional[List[str]]Default:NoneMeaning: Grouping columns for structure tests. Example TOML:pqc_structure_group_cols = ["sys"]
Example CLI:
pleb --config pipeline.toml --set pqc_structure_group_cols=["sys"]
pqc_outlier_gate_enabledType:
boolDefault:FalseMeaning: Enable hard sigma gate for outlier membership. Example TOML:pqc_outlier_gate_enabled = true
Example CLI:
pleb --config pipeline.toml --set pqc_outlier_gate_enabled=true
pqc_outlier_gate_sigmaType:
floatDefault:3.0Meaning: Sigma threshold for outlier gate. Example TOML:pqc_outlier_gate_sigma = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_outlier_gate_sigma=1.0
pqc_outlier_gate_resid_colType:
Optional[str]Default:NoneMeaning: Residual column to gate on (optional). Example TOML:pqc_outlier_gate_resid_col = "post"
Example CLI:
pleb --config pipeline.toml --set pqc_outlier_gate_resid_col="post"
pqc_outlier_gate_sigma_colType:
Optional[str]Default:NoneMeaning: Sigma column to gate on (optional). Example TOML:pqc_outlier_gate_sigma_col = "err"
Example CLI:
pleb --config pipeline.toml --set pqc_outlier_gate_sigma_col="err"
pqc_event_instrumentType:
boolDefault:FalseMeaning: Enable per-event membership diagnostics. Example TOML:pqc_event_instrument = true
Example CLI:
pleb --config pipeline.toml --set pqc_event_instrument=true
pqc_solar_events_enabledType:
boolDefault:FalseMeaning: Enable solar event detection. Example TOML:pqc_solar_events_enabled = true
Example CLI:
pleb --config pipeline.toml --set pqc_solar_events_enabled=true
pqc_solar_approach_max_degType:
floatDefault:30.0Meaning: Max elongation for solar approach region. Example TOML:pqc_solar_approach_max_deg = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_solar_approach_max_deg=1.0
pqc_solar_min_points_globalType:
intDefault:30Meaning: Min points for global fit. Example TOML:pqc_solar_min_points_global = 4
Example CLI:
pleb --config pipeline.toml --set pqc_solar_min_points_global=4
pqc_solar_min_points_yearType:
intDefault:10Meaning: Min points for per-year fit. Example TOML:pqc_solar_min_points_year = 4
Example CLI:
pleb --config pipeline.toml --set pqc_solar_min_points_year=4
pqc_solar_min_points_near_zeroType:
intDefault:3Meaning: Min points near zero elongation. Example TOML:pqc_solar_min_points_near_zero = 4
Example CLI:
pleb --config pipeline.toml --set pqc_solar_min_points_near_zero=4
pqc_solar_tau_min_degType:
floatDefault:2.0Meaning: Min elongation scale for exponential. Example TOML:pqc_solar_tau_min_deg = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_solar_tau_min_deg=1.0
pqc_solar_tau_max_degType:
floatDefault:60.0Meaning: Max elongation scale for exponential. Example TOML:pqc_solar_tau_max_deg = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_solar_tau_max_deg=1.0
pqc_solar_member_etaType:
floatDefault:1.0Meaning: Per-point membership SNR threshold. Example TOML:pqc_solar_member_eta = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_solar_member_eta=1.0
pqc_solar_freq_dependenceType:
boolDefault:TrueMeaning: Fit 1/f^alpha dependence. Example TOML:pqc_solar_freq_dependence = false
Example CLI:
pleb --config pipeline.toml --set pqc_solar_freq_dependence=false
pqc_solar_freq_alpha_minType:
floatDefault:0.0Meaning: Lower bound for alpha. Example TOML:pqc_solar_freq_alpha_min = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_solar_freq_alpha_min=1.0
pqc_solar_freq_alpha_maxType:
floatDefault:4.0Meaning: Upper bound for alpha. Example TOML:pqc_solar_freq_alpha_max = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_solar_freq_alpha_max=1.0
pqc_solar_freq_alpha_tolType:
floatDefault:0.001Meaning: Optimization tolerance for alpha. Example TOML:pqc_solar_freq_alpha_tol = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_solar_freq_alpha_tol=1.0
pqc_solar_freq_alpha_max_iterType:
intDefault:64Meaning: Max iterations for alpha optimizer. Example TOML:pqc_solar_freq_alpha_max_iter = 4
Example CLI:
pleb --config pipeline.toml --set pqc_solar_freq_alpha_max_iter=4
pqc_orbital_phase_cut_enabledType:
boolDefault:FalseMeaning: Enable orbital-phase based flagging. Example TOML:pqc_orbital_phase_cut_enabled = true
Example CLI:
pleb --config pipeline.toml --set pqc_orbital_phase_cut_enabled=true
pqc_orbital_phase_cut_centerType:
floatDefault:0.25Meaning: Eclipse center phase (0..1). Example TOML:pqc_orbital_phase_cut_center = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_orbital_phase_cut_center=1.0
pqc_orbital_phase_cutType:
Optional[float]Default:NoneMeaning: Fixed orbital-phase cutoff (0..0.5), or None for auto. Example TOML:pqc_orbital_phase_cut = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_orbital_phase_cut=1.0
pqc_orbital_phase_cut_sigmaType:
floatDefault:3.0Meaning: Sigma threshold for automatic cutoff estimation. Example TOML:pqc_orbital_phase_cut_sigma = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_orbital_phase_cut_sigma=1.0
pqc_orbital_phase_cut_nbinsType:
intDefault:18Meaning: Number of bins for cutoff estimation. Example TOML:pqc_orbital_phase_cut_nbins = 4
Example CLI:
pleb --config pipeline.toml --set pqc_orbital_phase_cut_nbins=4
pqc_orbital_phase_cut_min_pointsType:
intDefault:20Meaning: Minimum points for cutoff estimation. Example TOML:pqc_orbital_phase_cut_min_points = 4
Example CLI:
pleb --config pipeline.toml --set pqc_orbital_phase_cut_min_points=4
pqc_eclipse_events_enabledType:
boolDefault:FalseMeaning: Enable eclipse event detection. Example TOML:pqc_eclipse_events_enabled = true
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_events_enabled=true
pqc_eclipse_center_phaseType:
floatDefault:0.25Meaning: Eclipse center phase (0..1). Example TOML:pqc_eclipse_center_phase = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_center_phase=1.0
pqc_eclipse_min_pointsType:
intDefault:30Meaning: Min points for global fit. Example TOML:pqc_eclipse_min_points = 4
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_min_points=4
pqc_eclipse_width_minType:
floatDefault:0.01Meaning: Min eclipse width in phase. Example TOML:pqc_eclipse_width_min = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_width_min=1.0
pqc_eclipse_width_maxType:
floatDefault:0.5Meaning: Max eclipse width in phase. Example TOML:pqc_eclipse_width_max = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_width_max=1.0
pqc_eclipse_member_etaType:
floatDefault:1.0Meaning: Per-point membership SNR threshold. Example TOML:pqc_eclipse_member_eta = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_member_eta=1.0
pqc_eclipse_freq_dependenceType:
boolDefault:TrueMeaning: Fit 1/f^alpha dependence. Example TOML:pqc_eclipse_freq_dependence = false
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_freq_dependence=false
pqc_eclipse_freq_alpha_minType:
floatDefault:0.0Meaning: Lower bound for alpha. Example TOML:pqc_eclipse_freq_alpha_min = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_freq_alpha_min=1.0
pqc_eclipse_freq_alpha_maxType:
floatDefault:4.0Meaning: Upper bound for alpha. Example TOML:pqc_eclipse_freq_alpha_max = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_freq_alpha_max=1.0
pqc_eclipse_freq_alpha_tolType:
floatDefault:0.001Meaning: Optimization tolerance for alpha. Example TOML:pqc_eclipse_freq_alpha_tol = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_freq_alpha_tol=1.0
pqc_eclipse_freq_alpha_max_iterType:
intDefault:64Meaning: Max iterations for alpha optimizer. Example TOML:pqc_eclipse_freq_alpha_max_iter = 4
Example CLI:
pleb --config pipeline.toml --set pqc_eclipse_freq_alpha_max_iter=4
pqc_gaussian_bump_enabledType:
boolDefault:FalseMeaning: Enable Gaussian-bump event detection. Example TOML:pqc_gaussian_bump_enabled = true
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_enabled=true
pqc_gaussian_bump_min_duration_daysType:
floatDefault:60.0Meaning: Minimum bump duration in days. Example TOML:pqc_gaussian_bump_min_duration_days = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_min_duration_days=1.0
pqc_gaussian_bump_max_duration_daysType:
floatDefault:1500.0Meaning: Maximum bump duration in days. Example TOML:pqc_gaussian_bump_max_duration_days = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_max_duration_days=1.0
pqc_gaussian_bump_n_durationsType:
intDefault:6Meaning: Number of duration grid points. Example TOML:pqc_gaussian_bump_n_durations = 4
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_n_durations=4
pqc_gaussian_bump_min_pointsType:
intDefault:20Meaning: Minimum points for bump detection. Example TOML:pqc_gaussian_bump_min_points = 4
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_min_points=4
pqc_gaussian_bump_delta_chi2_threshType:
floatDefault:25.0Meaning: Delta-chi2 threshold for bump detection. Example TOML:pqc_gaussian_bump_delta_chi2_thresh = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_delta_chi2_thresh=1.0
pqc_gaussian_bump_suppress_overlapType:
boolDefault:TrueMeaning: Suppress overlapping bumps. Example TOML:pqc_gaussian_bump_suppress_overlap = false
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_suppress_overlap=false
pqc_gaussian_bump_member_etaType:
floatDefault:1.0Meaning: Per-point membership SNR threshold. Example TOML:pqc_gaussian_bump_member_eta = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_member_eta=1.0
pqc_gaussian_bump_freq_dependenceType:
boolDefault:TrueMeaning: Fit 1/f^alpha dependence. Example TOML:pqc_gaussian_bump_freq_dependence = false
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_freq_dependence=false
pqc_gaussian_bump_freq_alpha_minType:
floatDefault:0.0Meaning: Lower bound for alpha. Example TOML:pqc_gaussian_bump_freq_alpha_min = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_freq_alpha_min=1.0
pqc_gaussian_bump_freq_alpha_maxType:
floatDefault:4.0Meaning: Upper bound for alpha. Example TOML:pqc_gaussian_bump_freq_alpha_max = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_freq_alpha_max=1.0
pqc_gaussian_bump_freq_alpha_tolType:
floatDefault:0.001Meaning: Optimization tolerance for alpha. Example TOML:pqc_gaussian_bump_freq_alpha_tol = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_freq_alpha_tol=1.0
pqc_gaussian_bump_freq_alpha_max_iterType:
intDefault:64Meaning: Max iterations for alpha optimizer. Example TOML:pqc_gaussian_bump_freq_alpha_max_iter = 4
Example CLI:
pleb --config pipeline.toml --set pqc_gaussian_bump_freq_alpha_max_iter=4
pqc_glitch_enabledType:
boolDefault:FalseMeaning: Enable glitch event detection. Example TOML:pqc_glitch_enabled = true
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_enabled=true
pqc_glitch_min_pointsType:
intDefault:30Meaning: Minimum points for glitch detection. Example TOML:pqc_glitch_min_points = 4
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_min_points=4
pqc_glitch_delta_chi2_threshType:
floatDefault:25.0Meaning: Delta-chi2 threshold for glitch detection. Example TOML:pqc_glitch_delta_chi2_thresh = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_delta_chi2_thresh=1.0
pqc_glitch_suppress_overlapType:
boolDefault:TrueMeaning: Suppress overlapping glitches. Example TOML:pqc_glitch_suppress_overlap = false
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_suppress_overlap=false
pqc_glitch_member_etaType:
floatDefault:1.0Meaning: Per-point membership SNR threshold. Example TOML:pqc_glitch_member_eta = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_member_eta=1.0
pqc_glitch_peak_tau_daysType:
floatDefault:30.0Meaning: Peak exponential timescale for glitch model. Example TOML:pqc_glitch_peak_tau_days = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_peak_tau_days=1.0
pqc_glitch_noise_kType:
floatDefault:1.0Meaning: Noise-aware threshold multiplier. Example TOML:pqc_glitch_noise_k = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_noise_k=1.0
pqc_glitch_mean_window_daysType:
floatDefault:180.0Meaning: Rolling-mean window (days) for zero-crossing. Example TOML:pqc_glitch_mean_window_days = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_mean_window_days=1.0
pqc_glitch_min_duration_daysType:
floatDefault:1000.0Meaning: Minimum glitch duration (days). Example TOML:pqc_glitch_min_duration_days = 1.0
Example CLI:
pleb --config pipeline.toml --set pqc_glitch_min_duration_days=1.0
pqc_backend_profiles_pathType:
Optional[str]Default:NoneMeaning: Optional TOML with per-backend pqc overrides. Example TOML:pqc_backend_profiles_path = "configs/rules/pqc/backend_profiles.example.toml"
Example CLI:
pleb --config pipeline.toml --set pqc_backend_profiles_path="configs/rules/pqc/backend_profiles.example.toml"
QC report settings¶
qc_report_backend_colType:
Optional[str]Default:NoneMeaning: Backend column name for reports (optional). Example TOML:qc_report_backend_col = "sys"
Example CLI:
pleb --config pipeline.toml --set qc_report_backend_col="sys"
qc_report_backendType:
Optional[str]Default:NoneMeaning: Optional backend key to plot. Example TOML:qc_report_backend = "NRT.NUPPI.1484"
Example CLI:
pleb --config pipeline.toml --set qc_report_backend="NRT.NUPPI.1484"
qc_report_dirType:
Optional[Path]Default:NoneMeaning: Output directory for reports (optional). Example TOML:qc_report_dir = "results/qc_report"
Example CLI:
pleb --config pipeline.toml --set qc_report_dir="results/qc_report"
qc_report_no_plotsType:
boolDefault:FalseMeaning: Skip transient plots in reports. Example TOML:qc_report_no_plots = true
Example CLI:
pleb --config pipeline.toml --set qc_report_no_plots=true
qc_report_structure_group_colsType:
Optional[str]Default:NoneMeaning: Structure grouping override for reports. Example TOML:qc_report_structure_group_cols = "value"
Example CLI:
pleb --config pipeline.toml --set qc_report_structure_group_cols="value"
qc_report_no_feature_plotsType:
boolDefault:FalseMeaning: Skip feature plots in reports. Example TOML:qc_report_no_feature_plots = true
Example CLI:
pleb --config pipeline.toml --set qc_report_no_feature_plots=true
qc_report_compact_pdfType:
boolDefault:FalseMeaning: Generate compact composite PDF report. Example TOML:qc_report_compact_pdf = true
Example CLI:
pleb --config pipeline.toml --set qc_report_compact_pdf=true
qc_report_compact_pdf_nameType:
strDefault:'qc_compact_report.pdf'Meaning: Filename for compact PDF report. Example TOML:qc_report_compact_pdf_name = "qc_compact_report.pdf"
Example CLI:
pleb --config pipeline.toml --set qc_report_compact_pdf_name="qc_compact_report.pdf"
qc_report_compact_outlier_colsType:
Optional[List[str]]Default:NoneMeaning: QC report generation setting. Example TOML:qc_report_compact_outlier_cols = ["bad_point","robust_outlier","robust_global_outlier","bad_mad"]
Example CLI:
pleb --config pipeline.toml --set qc_report_compact_outlier_cols=["bad_point","robust_outlier","robust_global_outlier","bad_mad"]
FixDataset settings¶
fix_applyType:
boolDefault:FalseMeaning: Whether FixDataset applies changes and commits. Example TOML:fix_apply = true
Example CLI:
pleb --config pipeline.toml --set fix_apply=true
fix_branch_nameType:
Optional[str]Default:NoneMeaning: Name of FixDataset branch. If unset and fix_apply is true, Example TOML:fix_branch_name = "fix_dataset"
Example CLI:
pleb --config pipeline.toml --set fix_branch_name="fix_dataset"
fix_base_branchType:
Optional[str]Default:NoneMeaning: Base branch for FixDataset. Example TOML:fix_base_branch = "raw_ingest"
Example CLI:
pleb --config pipeline.toml --set fix_base_branch="raw_ingest"
fix_commit_messageType:
Optional[str]Default:NoneMeaning: Commit message for FixDataset. Example TOML:fix_commit_message = "FixDataset: normalize flags"
Example CLI:
pleb --config pipeline.toml --set fix_commit_message="FixDataset: normalize flags"
fix_backupType:
boolDefault:TrueMeaning: Create backup before FixDataset modifications. Example TOML:fix_backup = false
Example CLI:
pleb --config pipeline.toml --set fix_backup=false
fix_dry_runType:
boolDefault:FalseMeaning: If True, FixDataset does not write changes. Example TOML:fix_dry_run = true
Example CLI:
pleb --config pipeline.toml --set fix_dry_run=true
fix_update_alltim_includesType:
boolDefault:TrueMeaning: Update INCLUDE lines in .tim files. Example TOML:fix_update_alltim_includes = false
Example CLI:
pleb --config pipeline.toml --set fix_update_alltim_includes=false
fix_min_toas_per_backend_timType:
intDefault:10Meaning: Minimum TOAs per backend .tim. Example TOML:fix_min_toas_per_backend_tim = 4
Example CLI:
pleb --config pipeline.toml --set fix_min_toas_per_backend_tim=4
fix_required_tim_flagsType:
Dict[str, str]Default:{}Meaning: Required flags for .tim entries. Example TOML:fix_required_tim_flags = { "-pta" = "EPTA" }
Example CLI:
pleb --config pipeline.toml --set fix_required_tim_flags={ "-pta" = "EPTA" }
fix_system_flag_mapping_pathType:
Optional[str]Default:NoneMeaning: Editable system-flag mapping JSON (optional). Example TOML:fix_system_flag_mapping_path = "configs/catalogs/system_flags/system_flag_mapping.example.json"
Example CLI:
pleb --config pipeline.toml --set fix_system_flag_mapping_path="configs/catalogs/system_flags/system_flag_mapping.example.json"
fix_system_flag_table_pathType:
Optional[str]Default:NoneMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_system_flag_table_path = "system_flag_table.json"
Example CLI:
pleb --config pipeline.toml --set fix_system_flag_table_path="system_flag_table.json"
fix_generate_alltim_variantsType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_generate_alltim_variants = true
Example CLI:
pleb --config pipeline.toml --set fix_generate_alltim_variants=true
fix_backend_classifications_pathType:
Optional[str]Default:NoneMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_backend_classifications_path = "configs/catalogs/variants/backend_classifications_legacy_new.toml"
Example CLI:
pleb --config pipeline.toml --set fix_backend_classifications_path="configs/catalogs/variants/backend_classifications_legacy_new.toml"
fix_alltim_variants_pathType:
Optional[str]Default:NoneMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_alltim_variants_path = "configs/catalogs/variants/alltim_variants_legacy_new.toml"
Example CLI:
pleb --config pipeline.toml --set fix_alltim_variants_path="configs/catalogs/variants/alltim_variants_legacy_new.toml"
fix_relabel_rules_pathType:
Optional[str]Default:NoneMeaning: Declarative TOA relabel rules TOML (optional). Example TOML:fix_relabel_rules_path = "configs/rules/relabel/relabel_rules.example.toml"
Example CLI:
pleb --config pipeline.toml --set fix_relabel_rules_path="configs/rules/relabel/relabel_rules.example.toml"
fix_overlap_rules_pathType:
Optional[str]Default:NoneMeaning: Declarative overlap rules TOML (optional). Example TOML:fix_overlap_rules_path = "configs/rules/overlap/overlap_rules.example.toml"
Example CLI:
pleb --config pipeline.toml --set fix_overlap_rules_path="configs/rules/overlap/overlap_rules.example.toml"
fix_overlap_exact_catalog_pathType:
Optional[str]Default:NoneMeaning: TOML keep->drop map for exact overlap removal. Example TOML:fix_overlap_exact_catalog_path = "configs/catalogs/system_tables/overlapped_timfiles.toml"
Example CLI:
pleb --config pipeline.toml --set fix_overlap_exact_catalog_path="configs/catalogs/system_tables/overlapped_timfiles.toml"
fix_jump_reference_variantsType:
boolDefault:FalseMeaning: Build per-variant reference-system jump parfiles. Example TOML:fix_jump_reference_variants = true
Example CLI:
pleb --config pipeline.toml --set fix_jump_reference_variants=true
fix_jump_reference_keep_tmpType:
boolDefault:FalseMeaning: Keep temporary split tim/par files. Example TOML:fix_jump_reference_keep_tmp = true
Example CLI:
pleb --config pipeline.toml --set fix_jump_reference_keep_tmp=true
fix_jump_reference_jump_flagType:
strDefault:'-sys'Meaning: Jump flag used in generated variant parfiles. Example TOML:fix_jump_reference_jump_flag = "-sys"
Example CLI:
pleb --config pipeline.toml --set fix_jump_reference_jump_flag="-sys"
fix_jump_reference_csv_dirType:
Optional[str]Default:NoneMeaning: Output directory for jump-reference CSV files. Example TOML:fix_jump_reference_csv_dir = "results/jump_reference"
Example CLI:
pleb --config pipeline.toml --set fix_jump_reference_csv_dir="results/jump_reference"
fix_infer_system_flagsType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_infer_system_flags = true
Example CLI:
pleb --config pipeline.toml --set fix_infer_system_flags=true
fix_system_flag_overwrite_existingType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_system_flag_overwrite_existing = true
Example CLI:
pleb --config pipeline.toml --set fix_system_flag_overwrite_existing=true
fix_wsrt_p2_force_sys_by_freqType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_wsrt_p2_force_sys_by_freq = true
Example CLI:
pleb --config pipeline.toml --set fix_wsrt_p2_force_sys_by_freq=true
fix_wsrt_p2_prefer_dual_channelType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_wsrt_p2_prefer_dual_channel = true
Example CLI:
pleb --config pipeline.toml --set fix_wsrt_p2_prefer_dual_channel=true
fix_wsrt_p2_mjd_tol_secType:
floatDefault:9.9e-07Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_wsrt_p2_mjd_tol_sec = 1.0
Example CLI:
pleb --config pipeline.toml --set fix_wsrt_p2_mjd_tol_sec=1.0
fix_wsrt_p2_actionType:
strDefault:'comment'Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_wsrt_p2_action = "comment"
Example CLI:
pleb --config pipeline.toml --set fix_wsrt_p2_action="comment"
fix_wsrt_p2_comment_prefixType:
strDefault:'C WSRT_P2_PREFER_DUAL'Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_wsrt_p2_comment_prefix = "C WSRT_P2_PREFER_DUAL"
Example CLI:
pleb --config pipeline.toml --set fix_wsrt_p2_comment_prefix="C WSRT_P2_PREFER_DUAL"
fix_backend_overridesType:
Dict[str, str]Default:{}Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_backend_overrides = { "JBO.DFB.1400.tim" = "DFB" }
Example CLI:
pleb --config pipeline.toml --set fix_backend_overrides={ "JBO.DFB.1400.tim" = "DFB" }
fix_raise_on_backend_missingType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_raise_on_backend_missing = true
Example CLI:
pleb --config pipeline.toml --set fix_raise_on_backend_missing=true
fix_dedupe_toas_within_timType:
boolDefault:TrueMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_dedupe_toas_within_tim = false
Example CLI:
pleb --config pipeline.toml --set fix_dedupe_toas_within_tim=false
fix_dedupe_mjd_tol_secType:
floatDefault:0.0Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_dedupe_mjd_tol_sec = 1.0
Example CLI:
pleb --config pipeline.toml --set fix_dedupe_mjd_tol_sec=1.0
fix_dedupe_freq_tol_mhzType:
Optional[float]Default:NoneMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_dedupe_freq_tol_mhz = 1.0
Example CLI:
pleb --config pipeline.toml --set fix_dedupe_freq_tol_mhz=1.0
fix_dedupe_freq_tol_autoType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_dedupe_freq_tol_auto = true
Example CLI:
pleb --config pipeline.toml --set fix_dedupe_freq_tol_auto=true
fix_check_duplicate_backend_timsType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_check_duplicate_backend_tims = true
Example CLI:
pleb --config pipeline.toml --set fix_check_duplicate_backend_tims=true
fix_remove_overlaps_exactType:
boolDefault:TrueMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_remove_overlaps_exact = false
Example CLI:
pleb --config pipeline.toml --set fix_remove_overlaps_exact=false
fix_insert_missing_jumpsType:
boolDefault:TrueMeaning: Insert missing JUMP lines. Example TOML:fix_insert_missing_jumps = false
Example CLI:
pleb --config pipeline.toml --set fix_insert_missing_jumps=false
fix_jump_flagType:
strDefault:'-sys'Meaning: Flag used for inserted jumps. Example TOML:fix_jump_flag = "-sys"
Example CLI:
pleb --config pipeline.toml --set fix_jump_flag="-sys"
fix_prune_stale_jumpsType:
boolDefault:FalseMeaning: Drop JUMPs not present in timfile flags. Example TOML:fix_prune_stale_jumps = true
Example CLI:
pleb --config pipeline.toml --set fix_prune_stale_jumps=true
fix_ensure_ephemType:
Optional[str]Default:NoneMeaning: Ensure ephemeris parameter exists. Example TOML:fix_ensure_ephem = "DE440"
Example CLI:
pleb --config pipeline.toml --set fix_ensure_ephem="DE440"
fix_ensure_clkType:
Optional[str]Default:NoneMeaning: Ensure clock parameter exists. Example TOML:fix_ensure_clk = "TT(BIPM2024)"
Example CLI:
pleb --config pipeline.toml --set fix_ensure_clk="TT(BIPM2024)"
fix_ensure_ne_swType:
Optional[str]Default:NoneMeaning: Ensure NE_SW parameter exists. Example TOML:fix_ensure_ne_sw = "7.9"
Example CLI:
pleb --config pipeline.toml --set fix_ensure_ne_sw="7.9"
fix_force_ne_sw_overwriteType:
boolDefault:FalseMeaning: Overwrite existing NE_SW values when true. Example TOML:fix_force_ne_sw_overwrite = true
Example CLI:
pleb --config pipeline.toml --set fix_force_ne_sw_overwrite=true
fix_remove_patternsType:
List[str]Default:['NRT.NUPPI.', 'NRT.NUXPI.']Meaning: Patterns to remove from .par/.tim. Example TOML:fix_remove_patterns = ["NRT.NUPPI.","NRT.NUXPI."]
Example CLI:
pleb --config pipeline.toml --set fix_remove_patterns=["NRT.NUPPI.","NRT.NUXPI."]
fix_coord_convertType:
Optional[str]Default:NoneMeaning: Optional coordinate conversion. Example TOML:fix_coord_convert = "equatorial_to_ecliptic"
Example CLI:
pleb --config pipeline.toml --set fix_coord_convert="equatorial_to_ecliptic"
fix_prune_missing_includesType:
boolDefault:TrueMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_prune_missing_includes = false
Example CLI:
pleb --config pipeline.toml --set fix_prune_missing_includes=false
fix_drop_small_backend_includesType:
boolDefault:TrueMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_drop_small_backend_includes = false
Example CLI:
pleb --config pipeline.toml --set fix_drop_small_backend_includes=false
fix_system_flag_update_tableType:
boolDefault:TrueMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_system_flag_update_table = false
Example CLI:
pleb --config pipeline.toml --set fix_system_flag_update_table=false
fix_default_backendType:
Optional[str]Default:NoneMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_default_backend = "NUPPI"
Example CLI:
pleb --config pipeline.toml --set fix_default_backend="NUPPI"
fix_group_flagType:
strDefault:'-group'Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_group_flag = "-group"
Example CLI:
pleb --config pipeline.toml --set fix_group_flag="-group"
fix_pta_flagType:
strDefault:'-pta'Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_pta_flag = "-pta"
Example CLI:
pleb --config pipeline.toml --set fix_pta_flag="-pta"
fix_pta_valueType:
Optional[str]Default:NoneMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_pta_value = "EPTA"
Example CLI:
pleb --config pipeline.toml --set fix_pta_value="EPTA"
fix_standardize_par_valuesType:
boolDefault:TrueMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_standardize_par_values = false
Example CLI:
pleb --config pipeline.toml --set fix_standardize_par_values=false
fix_prune_small_system_toasType:
boolDefault:FalseMeaning: FixDataset cleanup/normalization setting. Example TOML:fix_prune_small_system_toas = true
Example CLI:
pleb --config pipeline.toml --set fix_prune_small_system_toas=true
fix_prune_small_system_flagType:
strDefault:'-sys'Meaning: FixDataset cleanup/normalization setting. Example TOML:fix_prune_small_system_flag = "-sys"
Example CLI:
pleb --config pipeline.toml --set fix_prune_small_system_flag="-sys"
fix_qc_remove_outliersType:
boolDefault:FalseMeaning: Comment/delete TOAs flagged by pqc outputs. Example TOML:fix_qc_remove_outliers = true
Example CLI:
pleb --config pipeline.toml --set fix_qc_remove_outliers=true
fix_qc_outlier_colsType:
Optional[List[str]]Default:NoneMeaning: FixDataset action policy for PQC-derived flags. Example TOML:fix_qc_outlier_cols = ["bad_point","robust_outlier","robust_global_outlier","bad_mad"]
Example CLI:
pleb --config pipeline.toml --set fix_qc_outlier_cols=["bad_point","robust_outlier","robust_global_outlier","bad_mad"]
fix_qc_actionType:
strDefault:'comment'Meaning: Action for pqc outliers (comment/delete). Example TOML:fix_qc_action = "comment"
Example CLI:
pleb --config pipeline.toml --set fix_qc_action="comment"
fix_qc_comment_prefixType:
strDefault:'C QC_OUTLIER'Meaning: Prefix for commented TOA lines. Example TOML:fix_qc_comment_prefix = "C QC_OUTLIER"
Example CLI:
pleb --config pipeline.toml --set fix_qc_comment_prefix="C QC_OUTLIER"
fix_qc_backend_colType:
strDefault:'sys'Meaning: Backend column for pqc matching (if needed). Example TOML:fix_qc_backend_col = "sys"
Example CLI:
pleb --config pipeline.toml --set fix_qc_backend_col="sys"
fix_qc_remove_badType:
boolDefault:TrueMeaning: Act on bad/bad_day flags. Example TOML:fix_qc_remove_bad = false
Example CLI:
pleb --config pipeline.toml --set fix_qc_remove_bad=false
fix_qc_remove_transientsType:
boolDefault:FalseMeaning: Act on transient flags. Example TOML:fix_qc_remove_transients = true
Example CLI:
pleb --config pipeline.toml --set fix_qc_remove_transients=true
fix_qc_remove_solarType:
boolDefault:FalseMeaning: Act on solar-elongation flags. Example TOML:fix_qc_remove_solar = true
Example CLI:
pleb --config pipeline.toml --set fix_qc_remove_solar=true
fix_qc_solar_actionType:
strDefault:'comment'Meaning: Action for solar-flagged TOAs (comment/delete). Example TOML:fix_qc_solar_action = "comment"
Example CLI:
pleb --config pipeline.toml --set fix_qc_solar_action="comment"
fix_qc_solar_comment_prefixType:
strDefault:'# QC_SOLAR'Meaning: Prefix for solar-flagged TOA comments. Example TOML:fix_qc_solar_comment_prefix = "# QC_SOLAR"
Example CLI:
pleb --config pipeline.toml --set fix_qc_solar_comment_prefix="# QC_SOLAR"
fix_qc_remove_orbital_phaseType:
boolDefault:FalseMeaning: Act on orbital-phase flags. Example TOML:fix_qc_remove_orbital_phase = true
Example CLI:
pleb --config pipeline.toml --set fix_qc_remove_orbital_phase=true
fix_qc_orbital_phase_actionType:
strDefault:'comment'Meaning: Action for orbital-phase flagged TOAs (comment/delete). Example TOML:fix_qc_orbital_phase_action = "comment"
Example CLI:
pleb --config pipeline.toml --set fix_qc_orbital_phase_action="comment"
fix_qc_orbital_phase_comment_prefixType:
strDefault:'# QC_BIANRY_ECLIPSE'Meaning: Prefix for orbital-phase TOA comments. Example TOML:fix_qc_orbital_phase_comment_prefix = "# QC_BINARY_ECLIPSE"
Example CLI:
pleb --config pipeline.toml --set fix_qc_orbital_phase_comment_prefix="# QC_BINARY_ECLIPSE"
fix_qc_merge_tol_daysType:
floatDefault:2.0 / 86400.0Meaning: MJD tolerance when matching TOAs. Example TOML:fix_qc_merge_tol_days = 1.0
Example CLI:
pleb --config pipeline.toml --set fix_qc_merge_tol_days=1.0
fix_qc_results_dirType:
Optional[Path]Default:NoneMeaning: Directory containing pqc CSV outputs. If unset and Example TOML:fix_qc_results_dir = "results/EPTA_combination_report_20260319T1200"
Example CLI:
pleb --config pipeline.toml --set fix_qc_results_dir="results/EPTA_combination_report_20260319T1200"
fix_qc_branchType:
Optional[str]Default:NoneMeaning: Branch subdir for pqc CSV outputs. If unset and Example TOML:fix_qc_branch = "main"
Example CLI:
pleb --config pipeline.toml --set fix_qc_branch="main"
Param-scan settings¶
param_scan_typicalType:
boolDefault:FalseMeaning: Enable typical param-scan profile. Example TOML:param_scan_typical = true
Example CLI:
pleb --config pipeline.toml --set param_scan_typical=true
param_scan_dm_redchisq_thresholdType:
floatDefault:2.0Meaning: Threshold for DM scan. Example TOML:param_scan_dm_redchisq_threshold = 1.0
Example CLI:
pleb --config pipeline.toml --set param_scan_dm_redchisq_threshold=1.0
param_scan_dm_max_orderType:
intDefault:4Meaning: Max DM derivative order. Example TOML:param_scan_dm_max_order = 4
Example CLI:
pleb --config pipeline.toml --set param_scan_dm_max_order=4
param_scan_btx_max_fbType:
intDefault:3Meaning: Max FB derivative order. Example TOML:param_scan_btx_max_fb = 4
Example CLI:
pleb --config pipeline.toml --set param_scan_btx_max_fb=4
Binary analysis settings¶
binary_only_modelsType:
Optional[List[str]]Default:NoneMeaning: Limit binary analysis to model names. Example TOML:binary_only_models = ["ELL1","BTX"]
Example CLI:
pleb --config pipeline.toml --set binary_only_models=["ELL1","BTX"]
Ingest settings¶
ingest_mapping_fileType:
Optional[Path]Default:NoneMeaning: JSON mapping file for ingest mode (optional). Example TOML:ingest_mapping_file = "configs/catalogs/ingest/epta_data.json"
Example CLI:
pleb --config pipeline.toml --set ingest_mapping_file="configs/catalogs/ingest/epta_data.json"
ingest_output_dirType:
Optional[Path]Default:NoneMeaning: Output root directory for ingest mode (optional). Example TOML:ingest_output_dir = "/data/epta-dr3"
Example CLI:
pleb --config pipeline.toml --set ingest_output_dir="/data/epta-dr3"
ingest_commit_branchType:
boolDefault:TrueMeaning: Create a new branch and commit ingest outputs. Example TOML:ingest_commit_branch = false
Example CLI:
pleb --config pipeline.toml --set ingest_commit_branch=false
ingest_commit_branch_nameType:
Optional[str]Default:NoneMeaning: Optional name for the ingest branch. Example TOML:ingest_commit_branch_name = "raw_ingest"
Example CLI:
pleb --config pipeline.toml --set ingest_commit_branch_name="raw_ingest"
ingest_commit_base_branchType:
Optional[str]Default:NoneMeaning: Base branch for the ingest commit. Example TOML:ingest_commit_base_branch = "main"
Example CLI:
pleb --config pipeline.toml --set ingest_commit_base_branch="main"
ingest_commit_messageType:
Optional[str]Default:NoneMeaning: Commit message for ingest. Example TOML:ingest_commit_message = "Ingest: collect tim files"
Example CLI:
pleb --config pipeline.toml --set ingest_commit_message="Ingest: collect tim files"
ingest_verifyType:
boolDefault:FalseMeaning: Ingest setting. Example TOML:ingest_verify = true
Example CLI:
pleb --config pipeline.toml --set ingest_verify=true
Rendering settings¶
dpiType:
intDefault:120Meaning: Plot resolution. Example TOML:dpi = 150
Example CLI:
pleb --config pipeline.toml --set dpi=150
max_covmat_paramsType:
Optional[int]Default:NoneMeaning: Max params in covariance heatmaps. Example TOML:max_covmat_params = 80
Example CLI:
pleb --config pipeline.toml --set max_covmat_params=80