API Reference

The API reference is generated from the public libraries and modules exported by ilamb3. These classes and functions can be used by developers to build their own analyses, comparisons, and transforms.

• ilamb3.analysis

  • ILAMBAnalysis

  • add_overall_score

  • area_analysis

  • bias_analysis

  • cycle_analysis

  • dispersion_analysis

  • hydro_analysis

  • nbp_analysis

  • relationship_analysis

  • rmse_analysis

  • runoff_sensitivity_analysis

  • spatial_distribution_analysis

  • timeseries_analysis

• ilamb3.compare

  • adjust_lon

  • convert_calendar_monthly_noleap

  • is_spatially_aligned

  • make_comparable

  • nest_spatial_grids

  • pick_grid_aligned

  • rename_dims

  • same_spatial_grid

  • trim_time

• ilamb3.dataset

  • accumulate_time

  • cmip_cell_measures

  • coarsen_annual

  • coarsen_dataset

  • compute_annual_mean

  • compute_cell_measures

  • compute_monthly_climatology

  • compute_monthly_mean

  • compute_seasonal_climatology

  • compute_seasonal_mean

  • compute_time_measures

  • convert

  • convert_year_to_datetime

  • fix_missing_bounds_attrs

  • get_all_bounds_vars

  • get_ancillary_variable

  • get_bounds_variable

  • get_coord_name

  • get_dim_name

  • get_frequency_label

  • get_integer_dims

  • get_interval_uncertainty

  • get_mean_spatial_resolution

  • get_mean_time_frequency

  • get_scalar_uncertainty

  • get_time_extent

  • has_bounds

  • integrate_depth

  • integrate_space

  • integrate_time

  • is_gridded

  • is_latlon2d

  • is_layered

  • is_site

  • is_temporal

  • latlon2d_to_1d

  • ones_grid

  • scale_by_water_density

  • sel

  • shift_lon

  • shift_time_by_years

  • std_time

  • which_cell_measures

• ilamb3.regions

  • RegionLatLon

  • RegionNetCDF

  • RegionType

  • Regions

  • restrict_to_bbox

• ilamb3.run

  • augment_setup_with_options

  • find_related_variables

  • generate_html_page

  • parse_benchmark_setup

  • plot_analyses

  • regenerate_figs

  • registry_to_dataframe

  • run_analyses

  • run_single_block

  • run_study

  • select_analysis_variable

  • set_model_colors

  • setup_analyses

  • setup_transforms

• ilamb3.transform

  • ILAMBTransform

  • active_layer_thickness

  • agg_time_on_condition

  • apply_label

  • count_frost_days

  • count_ice_days

  • count_summer_days

  • count_tropical_nights

  • count_wet_days

  • daily_threshold_index

  • depth_gradient

  • expression

  • integrate

  • integrate_depth

  • integrate_space

  • integrate_time

  • mask_condition

  • msftmz_to_rapid

  • ocean_heat_content

  • permafrost_extent

  • quantile

  • rename

  • runoff_sensitivity

  • select_depth

  • select_dim

  • select_lat

  • select_lon

  • select_time

  • soil_moisture_to_vol_fraction

  • stratification_index