config_example.yaml

---
###############################################
#
#  Configuration file for CSST simulation
#  CSST-Sim Group, 2023/04/25
#
###############################################


# Base diretories and naming setup
# Can add some of the command-line arguments here as well;
# OK to pass either way or both, as long as they are consistent
work_dir: "/public/home/fangyuedong/20211203/CSST/workplace/"
data_dir: "/data/simudata/CSSOSDataProductsSims/data/"
run_name: "example"

# Whether to use MPI
run_option:
  use_mpi: YES
  # NOTE: "n_threads" paramters is currently not used in the backend
  # simulation codes. It should be implemented later in the web frontend
  # in order to config the number of threads to request from NAOC cluster
  n_threads: 80

  # Output catalog only?
  # If yes, no imaging simulation will run
  out_cat_only: NO

###############################################
# Catalog setting
###############################################
# Configure your catalog: options to be implemented 
# in the corresponding (user defined) 'Catalog' class
catalog_options:
  input_path:
    cat_dir: "catalog_points_7degree2/point_RA60.9624_DE-41.5032/"
    star_cat: "stars_ccd13_p_RA60.9624_DE-41.5032.hdf5"
    galaxy_cat: null

  SED_templates_path:
    star_SED: "SED_MMW_Gaia_Cluster_D20_SS.hdf5"
    galaxy_SED: null
  
  # Only simulate stars?
  star_only: YES

###############################################
# Observation setting
###############################################
obs_setting:

  # Options for survey types:
  # "Photometric": simulate photometric chips only
  # "Spectroscopic": simulate slitless spectroscopic chips only
  # "FGS": simulate FGS chips only (31-42)
  # "All": simulate full focal plane
  survey_type: "Photometric"
  
  # Exposure time [seconds]
  exp_time: 150.

  # Observation starting date & time
  date_obs: "210525" # [yymmdd]
  time_obs: "120000" # [hhmmss]

  # Default Pointing [degrees]
  # Note: NOT valid when a pointing list file is specified
  ra_center: 60.9624
  dec_center:  -41.5032
  # Image rotation [degree]
  image_rot: -113.4333

  # (Optional) a file of point list 
  # if you just want to run default pointing:
  # - pointing_dir: null
  # - pointing_file: null
  pointing_dir: null
  pointing_file: null

  # Number of calibration pointings
  np_cal: 2

  # Run specific pointing(s):
  # - give a list of indexes of pointings: [ip_1, ip_2...]
  # - run all pointings: null
  # Note: only valid when a pointing list is specified
  run_pointings: null
  
  # Run specific chip(s):
  # - give a list of indexes of chips: [ip_1, ip_2...]
  # - run all chips: null
  # Note: for all pointings
  run_chips: [18]

  # Whether to enable astrometric modeling
  enable_astrometric_model: True

  # Cut by saturation magnitude in which band?
  cut_in_band: "z"

  # saturation magnitude margin
  mag_sat_margin: -2.5

  # limiting magnitude margin
  mag_lim_margin: +1.0

###############################################
# PSF setting
###############################################
psf_setting:
  
  # Which PSF model to use:
  # "Gauss": simple gaussian profile
  # "Interp": Interpolated PSF from sampled ray-tracing data
  psf_model: "Interp"

  # PSF size [arcseconds]
  # radius of 80% energy encircled
  # NOTE: only valid for "Gauss" PSF
  psf_rcont: 0.15

  # path to PSF data
  # NOTE: only valid for "Interp" PSF
  psf_dir: "/data/simudata/CSSOSDataProductsSims/data/csstPSFdata/psfCube"

###############################################
# Shear setting
###############################################

shear_setting:
  # Options to generate mock shear field:
  # "constant": all galaxies are assigned a constant reduced shear
  # "catalog": from catalog
  # "extra": from seprate file
  shear_type: "constant"

  # For constant shear filed
  reduced_g1: 0.026
  reduced_g2: 0.015

  # Extra shear catalog
  # (currently not used)
  # shear_cat: "mockShear.cat"

###############################################
# Instrumental effects setting
###############################################
ins_effects:
  # switches
  # Note: bias_16channel, gain_16channel, and shutter_effect
  # is currently not applicable to "FGS" observations
  field_dist:     ON  # Whether to add field distortions
  add_back:       ON  # Whether to add sky background
  add_dark:       ON  # Whether to add dark noise
  add_readout:    ON  # Whether to add read-out (Gaussian) noise
  add_bias:       ON  # Whether to add bias-level to images
  bias_16channel: ON  # Whether to add different biases for 16 channels
  gain_16channel: ON  # Whether to make different gains for 16 channels
  shutter_effect: ON  # Whether to add shutter effect
  flat_fielding:  ON  # Whether to add flat-fielding effect
  prnu_effect:    ON  # Whether to add PRNU effect
  non_linear:     OFF # Whether to add non-linearity
  cosmic_ray:     ON  # Whether to add cosmic-ray
  cray_differ:    ON  # Whether to generate different cosmic ray maps CAL and MS output
  cte_trail:      ON  # Whether to simulate CTE trails
  saturbloom:     ON  # Whether to simulate Saturation & Blooming
  add_badcolumns: ON  # Whether to add bad columns
  add_hotpixels:  ON  # Whether to add hot pixels
  add_deadpixels: ON  # Whether to add dead(dark) pixels
  bright_fatter:  ON  # Whether to simulate Brighter-Fatter (also diffusion) effect

  # Values: 
  # default values have been defined individually for each chip in:
  # ObservationSim/Instrument/data/ccd/chip_definition.json
  # Set them here will override the default values
  # dark_exptime:   300   # Exposure time for dark current frames [seconds]
  # flat_exptime:   150   # Exposure time for flat-fielding frames [seconds]
  # readout_time:   40    # The read-out time for each channel [seconds]
  # df_strength:    2.3   # Sillicon sensor diffusion strength
  # bias_level:     500   # bias level [e-/pixel]
  # gain:           1.1   # Gain
  # full_well:      90000 # Full well depth [e-]

###############################################
# Output options (for calibration pointings only)
###############################################
output_setting:
  readout16:      OFF # Whether to export as 16 channels (subimages) with pre- and over-scan
  shutter_output: OFF # Whether to export shutter effect 16-bit image
  bias_output:    ON  # Whether to export bias frames
  dark_output:    ON  # Whether to export the combined dark current files
  flat_output:    ON  # Whether to export the combined flat-fielding files
  prnu_output:    OFF # Whether to export the PRNU (pixel-to-pixel flat-fielding) files
  NBias:          1     # Number of bias frames to be exported for each exposure
  NDark:          1     # Number of dark frames to be exported for each exposure
  NFlat:          1     # Number of flat frames to be exported for each exposure

###############################################
# Random seeds
###############################################
random_seeds:
  seed_poisson:         20210601  # Seed for Poisson noise
  seed_CR:              20210317  # Seed for generating random cosmic ray maps
  seed_flat:            20210101  # Seed for generating random flat fields
  seed_prnu:            20210102  # Seed for photo-response non-uniformity
  seed_gainNonUniform:  20210202  # Seed for gain nonuniformity
  seed_biasNonUniform:  20210203  # Seed for bias nonuniformity
  seed_rnNonUniform:    20210204  # Seed for readout-noise nonuniformity
  seed_badcolumns:      20240309  # Seed for bad columns
  seed_defective:       20210304  # Seed for defective (bad) pixels
  seed_readout:         20210601  # Seed for read-out gaussian noise
...