NEDAS.config.config module

class NEDAS.config.config.Config(config_file: str | None = None, parse_args: bool = False, **kwargs)[source]

Bases: object

Class to manage the configuration for running the NEDAS analysis. Configuration entries are described in details in Configuration file.

Parameters:
  • config_file (str, optional) – Path to the configuration file.

  • parse_args (bool, optional) – If true, parse command line arguments to collect configuration. Default is False.

  • **kwargs – Additional key-value pairs to be passed to parse_config. Can be used to override values in the config file.

directories: dict[str, str]
python_env: str | None
io_mode: Literal['online', 'offline']
job_submit: dict | None
nproc: int
nproc_mem: int
nproc_rec: int
nproc_util: int
pid: int
pid_mem: int
pid_rec: int
pid_show: int
nens: int
run_preproc: bool
run_forecast: bool
run_analysis: bool
run_postproc: bool
run_diagnose: bool
step: str | None
save_checkpoint: bool
call_stack: list[dict] | None
debug: bool
timer: bool
quiet: bool
interactive: bool | None
is_notebook: bool | None
call_stack_max_level: int | None
cols: int
anchor: int
tabspace: int
progress_bar_width: int
time: datetime
time_start: datetime
time_end: datetime
time_analysis_start: datetime
time_analysis_end: datetime
cycle_period: float
forecast_period: float
obs_time_steps: list[float]
obs_time_scale: float
state_time_steps: list[float]
state_time_scale: float
grid_def: dict
state_def: dict | None
model_def: dict | None
obs_def: dict | None
dataset_def: dict | None
shuffle_obs: bool
z_coords_from: Literal['mean', 'member']
interp_method: str
perturb: dict | None
scheme: str
niter: int
iter: int
resolution_level: list[int]
character_length: list[float]
localize_scale_fac: list[float]
obs_err_scale_fac: list[float]
assimilator_def: dict
updator_def: dict
covariance_def: dict
inflation_def: dict
localization_def: dict
transform_def: dict
diag: dict | None
work_dir: str
dump_yaml(config_file: str)[source]

Dump the current configuration to a YAML file.

Parameters:

config_file (str) – Path to the output configuration file.

summary() str[source]

Return a comprehensive summary of the NEDAS configuration.