Configuration

pyhanami uses the configuration files in src/pyhanami/config to manage analysis parameters and settings. This guide explains how to set up and customize these configuration files.

variables.yaml

The variables.yaml file is the main configuration file that defines climate variables and their corresponding metadata. Both the variable’s shortname and long name follow CMIP conventions (see CMIP6 Data Request).

Variable definitions

Required fields for each variable:

variable_name:  # Variable shortname
  check_enabled: bool # Whether to perform physical plausibility checks
  long_name: str  # Descriptive name of the variable
  mask: str  # Masking information (e.g., atm/oce)
  units: str  # Units of the variable

Note that additional fields to check the physical plausibility of a variable, such as max, min and/or boundaries, can be added.

scientific_evaluation_parameters.yaml

The scientific_evaluation_parameters.yaml file contains default parameters and their associated metadata for the scientific evaluation of several climate phenomena. It is organized into sections for each phenomenon, including:

• Tropical Intraseasonal Oscillation (ISO): iso

• Madden-Julian Oscillation (MJO): mjo

• Tropical Cyclones (TCs): tc

Parameter definitions

Within each section, parameters are defined with the following required fields:

parameter_name:  # Parameter shortname
  value: int | float | str  # Default value
  type: str  # Data type (e.g., int, float, tuple, str)
  units: str  # Units (if applicable)
  description: str  # Description of the parameter

For practical examples of using these configurations, see the User Guide.