weatherbench2.derived_variables.IntegratedWaterTransport
- class weatherbench2.derived_variables.IntegratedWaterTransport(u_name='u_component_of_wind', v_name='v_component_of_wind', water_species_name='specific_humidity', level_min=300, level_max=1000)
Compute integrated horizontal water transport in a vertical column.
Integrated vapor transport (IVT) is a useful diagnostic to include for understanding atmospheric rviers. Default pressure levels to include are taken from the GraphCast paper.
- Parameters:
u_name (str) –
v_name (str) –
water_species_name (str) –
level_min (Optional[float]) –
level_max (Optional[float]) –
- u_name
Name of wind U component.
- Type:
str
- v_name
Name of wind V component.
- Type:
str
- water_species_name
Name of water species to vertically integrate.
- Type:
str
- level_min
Minimum pressure level to include.
- Type:
Optional[float]
- level_max
Maximum pressure level to include.
- Type:
Optional[float]
- __init__(u_name='u_component_of_wind', v_name='v_component_of_wind', water_species_name='specific_humidity', level_min=300, level_max=1000)
- Parameters:
u_name (str) –
v_name (str) –
water_species_name (str) –
level_min (Optional[float]) –
level_max (Optional[float]) –
- Return type:
None
Methods
__init__
([u_name, v_name, ...])compute
(dataset)Compute derived variable, returning it in a new DataArray.
Attributes
all_input_core_dims
The set of all input core dimensions.
base_variables
Return a list of base variables.
core_dims
Return core dimensions needed for computing this variable.