credit.gefs

credit.gefs#

Functions#

download_gefs_run(init_date_str, out_path[, ...])

Download GEFS cube sphere netCDF files from AWS for a single initialization.

load_member_tiles(path, init_date_str, member, variables)

unstagger_winds(ds[, u_var, v_var, out_u, out_v])

combine_tiles(member_tiles[, flatten_dim, coord_dims])

regrid_member(member_tiles, regrid_weights_file)

interpolate_vertical_levels(regrid_ds, member_path, ...)

combine_microphysics_terms(regrid_ds[, ...])

rename_variables(ds, name_dict_file, meta_file, ...)

Rename variables from GEFS to target modeling system (e.g., ERA5 or CAM) variables. Uses a yaml file

process_member(member[, member_path, out_path, ...])

Module Contents#

credit.gefs.download_gefs_run(init_date_str: str, out_path: str, n_pert_members: int = 30)#

Download GEFS cube sphere netCDF files from AWS for a single initialization.

Parameters:

  • init_date_str – Initialization date in YYYY-MM-DD HHMM format or similar formats that pandas can handle.

  • out_path – Top-level path to save GEFS data on your local machines.

  • n_pert_members – Number of perturbation members to download. Max is 30. 0 only downloads the control member

credit.gefs.load_member_tiles(path: str, init_date_str: str, member: str, variables: str)#
Parameters:

  • path

  • init_date_str

  • member

  • variables

Returns:

credit.gefs.unstagger_winds(ds, u_var='u_s', v_var='v_w', out_u='u_a', out_v='v_a')#
credit.gefs.combine_tiles(member_tiles, flatten_dim='tile_lat_lon', coord_dims=('tile', 'lat', 'lon'))#
credit.gefs.regrid_member(member_tiles, regrid_weights_file)#
credit.gefs.interpolate_vertical_levels(regrid_ds, member_path, init_date_str, member, vertical_level_file, surface_pressure_var='ps', a_name='hyai', b_name='hybi', vert_dim='lev')#
Parameters:

  • regrid_ds

  • member_path

  • vertical_level_file

  • surface_pressure_var

  • a_name

  • b_name

  • vert_dim

Returns:

credit.gefs.combine_microphysics_terms(regrid_ds, microphysics_vars=('sphum', 'liq_wat', 'ice_wat', 'rainwat', 'snowwat', 'graupel'), total_var='Qtot')#
credit.gefs.rename_variables(ds, name_dict_file, meta_file, init_date_str)#

Rename variables from GEFS to target modeling system (e.g., ERA5 or CAM) variables. Uses a yaml file mapping GEFS to other names. Metadata can be added to the output Dataset using a metadata yaml file.

Parameters:

  • ds

  • name_dict_file

  • meta_file

  • init_date_str

Returns:

credit.gefs.process_member(member, member_path=None, out_path=None, init_date_str=None, variables=None, weight_file='', vertical_level_file='', rename_dict_file='', meta_file='')#