Skip to content

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

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