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
  logging_level: 30

  # Hardware
  hardware:
    gpu_info: True
    visible_gpus: [0]
    strategy: none

  # Misc
  print_params: False
  print_comp: False
  print_info: True
  print_imported_modules: True
  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	str	\( dimless \)	Url supplied to download .nc data files
folder_data	str	\( dimless \)	Folder that holds the data for default IGM downloading	data
logging_file	str	\( dimless \)
logging	bool	\( dimless \)		False
logging_level	str	\( dimless \)	30	30
hardware.gpu_info	bool	\( dimless \)	True	True
hardware.visible_gpus	list	\( dimless \)	visible gpus	[0]
hardware.strategy	str	\( dimless \)	strategy	none
print_params	bool	\( dimless \)	True	False
print_comp	bool	\( dimless \)	Print information related to computational performances	False
print_info	bool	\( dimless \)	Print live information when the model is running	True
print_imported_modules	bool	\( dimless \)	Print imported modules	True
check_compat_params	bool	\( dimless \)	Check compatibility btween default pasm name and user-defined one to check for typos, ect.	True
structure.root_foldername	str	\( dimless \)	user	user
structure.conf_foldername	str	\( dimless \)	conf	conf
structure.code_foldername	str	\( dimless \)	code	code
structure.input_modules_foldername	str	\( dimless \)	inputs	inputs
structure.process_modules_foldername	str	\( dimless \)	processes	processes
structure.output_modules_foldername	str	\( dimless \)	outputs	outputs