# SP2XR Complete Configuration Example

# ============================================================================
# METADATA - Optional documentation for this configuration
# ============================================================================
metadata:
  campaign: "Example_Campaign"
  instrument: "PSI SP2XR"
  operator: "Barbara Bertozzi"
  description: "Complete example configuration with all features enabled"
  created: "2025-09-29"

# ============================================================================
# FILE PATHS - All input and output locations
# ============================================================================
paths:
  input_pbp: data/pbp_files_parquet
  input_hk: data/hk_files_parquet
  output: data/SP2XR_processed_1min
  instrument_config: config/my_instrument_settings.yaml


# ============================================================================
# WORKFLOW SETTINGS - Complete analysis pipeline
# ============================================================================
workflow:
  # Analysis components
  conc: true              # Number and mass concentrations
  BC_hist: true           # BC mass distributions (dNdlogDmev, dMdlogDmev)
  scatt_hist: true        # Scattering size distributions (dNdlogDsc)
  timelag_hist: false      # Time-lag distributions for mixing state analysis

  # Time and data management
  dt: 60                  # Time resolution (seconds): 1, 10, 60, 300, 3600
  repartition: '1h'       # Repartition frequency: '15min', '1h', '6h', '1d'
  max_partition_size: "200MB"  # Memory management
  saving_schema: ['date', 'hour']  # Output partitioning scheme


# ============================================================================
# CLUSTER SETTINGS - HPC and local computing options
# ============================================================================
cluster:
  # Execution mode
  use_local: true        # true for local, false for SLURM cluster

  # Resource allocation
  cores: 32               # Total CPU cores
  processes: 16           # Worker processes (usually cores/2)
  memory: 256GB           # Total memory

  # SLURM-specific settings
  walltime: "4-00:00:00"  # Job time limit (days-hours:minutes:seconds)
  partition: general      # SLURM partition: general, bigmem, gpu, etc.
  log_dir: ./slurm_out    # SLURM log directory


# ============================================================================
# TIME CHUNKING - Temporal data processing strategy
# ============================================================================
chunking:
  freq: '7d'              # Chunk frequency: '1d', '3d', '7d', '1M'
  start_date: null  # Start date (YYYY-MM-DD format)
  end_date: null    # End date (YYYY-MM-DD format)


# ============================================================================
# BLACK CARBON PROPERTIES - Physical and optical parameters
# ============================================================================
bc:
  # Density settings
  rho_eff: 1800           # Effective density (kg/m³)
  type: constant_effective_density  # Density model

# ============================================================================
# DETAILED HISTOGRAM SETTINGS - Size and mass distribution parameters
# ============================================================================
histo:
  # Incandescence (BC mass) distributions
  inc:
    min_mass: 0.3         # Minimum mass (fg)
    max_mass: 400        # Maximum mass (fg)
    n_bins: 50           # Number of bins
    #log_spacing: true     # Logarithmic bin spacing

  # Scattering (optical diameter) distributions
  scatt:
    min_D: 100             # Minimum diameter (nm)
    max_D: 500            # Maximum diameter (nm)
    n_bins: 20            # Number of bins
    #log_spacing: true     # Logarithmic bin spacing

  # Time-lag distributions (mixing state analysis)
  timelag:
    min: -10              # Minimum time lag (ns)
    max: 400              # Maximum time lag (ns)
    n_bins: 100           # Number of bins
    #log_spacing: false    # Linear bin spacing for time-lag

# ============================================================================
# MIXING STATE ANALYSIS - Particle coating classification
# ============================================================================
mixing_state:
  # Classification thresholds
  threshold: 50           # Thick coating threshold (nm)
  inc_scatt_ratio: 1.1    # Minimum incandescence/scattering ratio


# ============================================================================
# ADVANCED CALIBRATION PARAMETERS
# ============================================================================
calibration:
  # Incandescence calibration
  incandescence:
    curve_type: "polynomial"    # "polynomial", "powerlaw", or "spline"
    parameters: [0.05, 2.047e-07, -1.2e-15]  # Calibration coefficients

  # Scattering calibration
  scattering:
    curve_type: "powerlaw"      # "polynomial", "powerlaw", or "spline"
    parameters: [17.22, 0.169, -1.494]  # [a, b, c] for powerlaw