YAML: generalclassGeneralConfig

General

Controls project scanning and asset root path mapping. All root_key:// protocol paths resolve through this block.

sourcefastsim/configs/general_cfg.py

Top-level Fields15

FieldTypeRequiredDefaultDescription / Constraints
scan_projectbooloptionalfalseScan user project on startup to auto-register custom stereotypes defined via @stereotype (executed by ProjectLoader.scan_project)
root_pathsdict[str, str]optional{}Asset root path mapping; keys become root_key:// protocol prefixes, values are local absolute directory paths
Each path must be an existing local directory; validate_root_paths() raises on startup if a path is missing
silenced_loggerslist[str]optional["isaaclab", "omni", "carb", "curobo"]List of third-party logger names to silence
log_to_terminalbooloptionaltrueWhether to output logs to the terminal
log_terminal_levelstringoptionalDEBUGTerminal log output level
DEBUG / INFO / WARNING / ERROR / CRITICAL
log_output_dirstringoptionalnullLog file output directory; null disables file logging
log_output_namestringoptionalnullLog file name (without extension); null for auto-generated
log_file_levelstringoptionalDEBUGFile log output level
DEBUG / INFO / WARNING / ERROR / CRITICAL
log_file_formatstringoptionaltextLog file format
text / json
log_file_max_size_mbfloatoptional10.0Maximum log file size in MB before rotation
log_file_backup_countintoptional5Number of rotated log file backups to retain
enable_profilingbooloptionalfalseEnable profiling to record time spent in each phase
profiling_outlier_threshold_msfloatoptional500.0Profiling outlier threshold in ms; calls exceeding this are flagged
cache_dirstringoptionalnullAsset cache directory (for remote/platform assets). null = use JOYSIM_CACHE_DIR env var, fallback to ~/.joysim_cache
seedintoptionalnullGlobal RNG seed (applied to random / numpy / torch / curobo). null = derive from current time; the resolved seed is logged at startup so non-deterministic runs can still be replayed

Example

general blockYAML
general:
  scan_project: true
  root_paths:
    assets: /home/user/robot_assets
    datasets: /home/user/datasets
  log_to_terminal: true
  log_terminal_level: INFO
  log_output_dir: logs/
  log_file_level: DEBUG
  log_file_format: text
  log_file_max_size_mb: 10.0
  log_file_backup_count: 5
  enable_profiling: false

# 使用效果 / Usage:
# assets://robots/ur5.usd  → /home/user/robot_assets/robots/ur5.usd
# datasets://runs/run001   → /home/user/datasets/runs/run001