Core

These core parameters are organized under a specific configuration structure designed to manage essential aspects of IGM's workflow, hardware preferences, and logging options.

Config Structure

core:
  # Input / Output
  url_data: ""
  folder_data: data
  logging_file: ""

  # Logging
  logging: False
  tf_logging_level: WARNING
  igm_logging_level: WARNING

  # Hardware
  hardware:
    gpu_info: False
    visible_gpus: [0]
    strategy: none
    profile: False

  # Misc
  print_params: False
  print_comp: False
  print_info: True
  print_imported_modules: False
  check_compat_params: True

  # Custom Modules
  structure:
    root_foldername: user
    conf_foldername: conf
    code_foldername: code
    input_modules_foldername: inputs
    process_modules_foldername: processes
    output_modules_foldername: outputs

Parameters

Name	Type	Units	Description	Default Value
url_data	string	\( dimless \)	URL from which to download `.nc` data files automatically.
folder_data	string	\( dimless \)	Local folder that holds input data downloaded or used by IGM.	data
logging_file	string	\( dimless \)	Path to a file for logging output. Leave empty to log to stdout only.
logging	boolean	\( dimless \)	Enable file-based logging.	False
tf_logging_level	string	\( dimless \)	TensorFlow logging verbosity level (`DEBUG`, `INFO`, `WARNING`, `ERROR`).	WARNING
igm_logging_level	string	\( dimless \)	IGM logging verbosity level (`DEBUG`, `INFO`, `WARNING`, `ERROR`).	WARNING
hardware.gpu_info	boolean	\( dimless \)	Print GPU information at startup.	False
hardware.visible_gpus	list	\( dimless \)	List of GPU device indices made visible to IGM. Only one GPU is used at a time.	[0]
hardware.strategy	string	\( dimless \)	TensorFlow distribution strategy (`none`, `mirrored`, etc.).	none
hardware.profile	boolean	\( dimless \)	Enable TensorFlow profiling for performance analysis.	False
print_params	boolean	\( dimless \)	Print the full resolved parameter configuration at startup.	False
print_comp	boolean	\( dimless \)	Print computational performance information (timing, throughput).	False
print_info	boolean	\( dimless \)	Print live simulation progress (time, time step, ice volume).	True
print_imported_modules	boolean	\( dimless \)	Print the list of imported modules at startup.	False
check_compat_params	boolean	\( dimless \)	Check that user-defined parameter names match known defaults, catching typos early.	True
structure.root_foldername	string	\( dimless \)	Root folder for custom modules, relative to the working directory.	user
structure.conf_foldername	string	\( dimless \)	Sub-folder inside the root folder containing Hydra configuration stubs.	conf
structure.code_foldername	string	\( dimless \)	Sub-folder inside the root folder containing Python module source files.	code
structure.input_modules_foldername	string	\( dimless \)	Sub-folder name for custom input modules.	inputs
structure.process_modules_foldername	string	\( dimless \)	Sub-folder name for custom process modules.	processes
structure.output_modules_foldername	string	\( dimless \)	Sub-folder name for custom output modules.	outputs