improver package

Subpackages

• improver.api package
  • Module contents
• improver.blending package
  • Submodules
    • improver.blending.blend_across_adjacent_points module
      • TriangularWeightedBlendAcrossAdjacentPoints
    • improver.blending.calculate_weights_and_blend module
      • WeightAndBlend
    • improver.blending.spatial_weights module
      • SpatiallyVaryingWeightsFromMask
    • improver.blending.utilities module
      • _get_cycletime_point()
      • _set_blended_time_coords()
      • find_blend_dim_coord()
      • get_coords_to_remove()
      • record_run_coord_to_attr()
      • store_record_run_as_coord()
      • update_blended_metadata()
      • update_record_run_weights()
    • improver.blending.weighted_blend module
      • MergeCubesForWeightedBlending
      • PercentileBlendingAggregator
      • WeightedBlendAcrossWholeDimension
    • improver.blending.weights module
      • ChooseDefaultWeightsLinear
      • ChooseDefaultWeightsNonLinear
      • ChooseDefaultWeightsTriangular
      • ChooseWeightsLinear
      • WeightsUtilities
  • Module contents
• improver.calibration package
  • Submodules
    • improver.calibration.beta_recalibration module
      • Beta recalibration
      • BetaRecalibrate
    • improver.calibration.dataframe_utilities module
      • Ingestion of DataFrames into iris cubes
      • _dataframe_column_check()
      • _define_height_coord()
      • _define_time_coord()
      • _drop_duplicates()
      • _ensure_consistent_static_cols()
      • _fill_missing_entries()
      • _prepare_dataframes()
      • _preprocess_temporal_columns()
      • _training_dates_for_calibration()
      • _unique_check()
      • forecast_and_truth_dataframes_to_cubes()
      • forecast_dataframe_to_cube()
      • get_forecast_representation()
      • quantile_check()
      • truth_dataframe_to_cube()
    • improver.calibration.dz_rescaling module
      • ApplyDzRescaling
      • EstimateDzRescaling
    • improver.calibration.emos_calibration module
      • Ensemble Model Output Statistics (EMOS)
      • ApplyEMOS
      • CalibratedForecastDistributionParameters
      • ContinuousRankedProbabilityScoreMinimisers
      • EstimateCoefficientsForEnsembleCalibration
      • convert_to_realizations()
      • generate_forecast_from_distribution()
      • get_attribute_from_coefficients()
      • get_forecast_type()
    • improver.calibration.load_and_apply_quantile_regression_random_forest module
      • PrepareAndApplyQRF
      • RandomForestQuantileRegressor
    • improver.calibration.load_and_train_quantile_regression_random_forest module
      • LoadForTrainQRF
      • PrepareAndTrainQRF
      • RandomForestQuantileRegressor
    • improver.calibration.quantile_regression_random_forest module
      • ApplyQuantileRegressionRandomForests
      • RandomForestQuantileRegressor
      • TrainQuantileRegressionRandomForests
      • _check_valid_transformation()
      • _drop_nans_from_forecast_df()
      • apply_transformation()
      • prep_feature()
      • prep_features_from_config()
      • quantile_forest_package_available()
      • sanitise_forecast_dataframe()
    • improver.calibration.rainforest_calibration module
      • RainForests calibration
      • ApplyRainForestsCalibration
      • ApplyRainForestsCalibrationLightGBM
      • ApplyRainForestsCalibrationTreelite
      • ModelFileNotFoundError
      • lightgbm_package_available()
      • treelite_packages_available()
    • improver.calibration.reliability_calibration module
      • AggregateReliabilityCalibrationTables
      • ApplyReliabilityCalibration
      • ConstructReliabilityCalibrationTables
      • ManipulateReliabilityTable
    • improver.calibration.samos_calibration module
      • ApplySAMOS
      • TrainEMOSForSAMOS
      • TrainGAMsForSAMOS
      • convert_dataframe_to_cube()
      • get_climatological_stats()
      • prepare_data_for_gam()
      • pygam
    • improver.calibration.simple_bias_correction module
      • ApplyBiasCorrection
      • CalculateForecastBias
      • apply_additive_correction()
      • evaluate_additive_error()
    • improver.calibration.utilities module
      • _ceiling_fp()
      • broadcast_data_to_time_coord()
      • check_data_sufficiency()
      • check_forecast_consistency()
      • check_predictor()
      • convert_cube_data_to_2d()
      • convert_parquet_to_cube()
      • create_unified_frt_coord()
      • filter_non_matching_cubes()
      • flatten_ignoring_masked_data()
      • forecast_coords_match()
      • get_frt_hours()
      • merge_land_and_sea()
      • prepare_cube_no_calibration()
  • Module contents
    • CalibrationSchemas
      • CalibrationSchemas.__init__()
    • add_feature_from_df_to_df()
    • add_static_feature_from_cube_to_df()
    • add_warning_comment()
    • get_common_wmo_ids()
    • get_training_period_cycles()
    • identify_parquet_type()
    • split_cubes_for_samos()
    • split_forecasts_and_bias_files()
    • split_forecasts_and_coeffs()
    • split_forecasts_and_truth()
    • split_netcdf_parquet_pickle()
    • validity_time_check()
• improver.categorical package
  • Submodules
    • improver.categorical.decision_tree module
      • ApplyDecisionTree
      • _define_invertible_conditions()
    • improver.categorical.modal_code module
      • BaseModalCategory
      • ModalCategory
      • ModalFromGroupings
    • improver.categorical.utilities module
      • _check_diagnostic_lists_consistency()
      • _check_nested_list_consistency()
      • categorical_attributes()
      • check_tree()
      • day_night_map()
      • dry_map()
      • expand_nested_lists()
      • get_parameter_names()
      • interrogate_decision_tree()
      • is_decision_node()
      • is_variable()
      • update_daynight()
      • update_tree_thresholds()
  • Module contents
• improver.cli package
  • Submodules
    • improver.cli.__main__ module
    • improver.cli.aggregate_reliability_tables module
      • process()
    • improver.cli.apply_beta_recalibration module
      • process()
    • improver.cli.apply_bias_correction module
      • process()
    • improver.cli.apply_dz_rescaling module
      • process()
    • improver.cli.apply_emos_coefficients module
      • process()
    • improver.cli.apply_height_adjustment module
      • process()
    • improver.cli.apply_lapse_rate module
      • process()
    • improver.cli.apply_mask module
      • process()
    • improver.cli.apply_night_mask module
      • process()
    • improver.cli.apply_quantile_regression_random_forest module
      • process()
    • improver.cli.apply_rainforests_calibration module
      • process()
    • improver.cli.apply_reliability_calibration module
      • process()
    • improver.cli.apply_samos_coefficients module
      • process()
    • improver.cli.between_thresholds module
      • process()
    • improver.cli.blend_adjacent_points module
      • process()
    • improver.cli.blend_cycles_and_realizations module
      • process()
    • improver.cli.blend_with_vicinity_and_rename module
      • process()
    • improver.cli.calculate_forecast_bias module
      • process()
    • improver.cli.categorical module
      • process()
    • improver.cli.categorical_modes module
      • process()
    • improver.cli.clip module
      • process()
    • improver.cli.cloud_condensation_level module
      • process()
    • improver.cli.cloud_top_temperature module
      • process()
    • improver.cli.collapse_realizations module
      • process()
    • improver.cli.combine module
      • process()
    • improver.cli.compare module
      • process()
    • improver.cli.construct_reliability_tables module
      • process()
    • improver.cli.convection_ratio module
      • process()
    • improver.cli.copy_metadata module
      • process()
    • improver.cli.create_grid_with_halo module
      • process()
    • improver.cli.cubelist_extract module
      • process()
    • improver.cli.duration_subdivision module
      • process()
    • improver.cli.enforce_consistent_forecasts module
      • process()
    • improver.cli.estimate_dz_rescaling module
      • process()
    • improver.cli.estimate_emos_coefficients module
      • process()
    • improver.cli.estimate_emos_coefficients_from_table module
      • process()
    • improver.cli.estimate_samos_coefficients module
      • process()
    • improver.cli.estimate_samos_coefficients_from_table module
      • process()
    • improver.cli.estimate_samos_gams module
      • process()
    • improver.cli.estimate_samos_gams_from_table module
      • process()
    • improver.cli.expected_value module
      • process()
    • improver.cli.extend_radar_mask module
      • process()
    • improver.cli.extract module
      • process()
    • improver.cli.extract_from_table module
      • process()
    • improver.cli.feels_like_temp module
      • process()
    • improver.cli.field_texture module
      • process()
    • improver.cli.fill_radar_holes module
      • process()
    • improver.cli.freezing_rain module
      • process()
    • improver.cli.generate_clearsky_solar_radiation module
      • process()
    • improver.cli.generate_landmask_ancillary module
      • process()
    • improver.cli.generate_metadata_cube module
      • process()
    • improver.cli.generate_orographic_smoothing_coefficients module
      • process()
    • improver.cli.generate_percentiles module
      • process()
    • improver.cli.generate_realizations module
      • process()
    • improver.cli.generate_solar_time module
      • process()
    • improver.cli.generate_topography_bands_mask module
      • process()
    • improver.cli.generate_topography_bands_weights module
      • process()
    • improver.cli.gradient_between_adjacent_grid_squares module
      • process()
    • improver.cli.gradient_between_vertical_levels module
      • process()
    • improver.cli.hail_fraction module
      • process()
    • improver.cli.hail_size module
      • process()
    • improver.cli.height_of_max_vertical_velocity module
      • process()
    • improver.cli.integrate_time_bounds module
      • process()
    • improver.cli.interpolate_using_difference module
      • process()
    • improver.cli.interpret_metadata module
      • process()
    • improver.cli.lightning_from_cape_and_precip module
      • process()
    • improver.cli.lightning_multivariate_probability_usaf2024 module
      • process()
    • improver.cli.manipulate_reliability_table module
      • process()
    • improver.cli.max_in_height module
      • process()
    • improver.cli.max_in_time_window module
      • process()
    • improver.cli.merge module
      • process()
    • improver.cli.nbhood module
      • process()
    • improver.cli.nbhood_iterate_with_mask module
      • process()
    • improver.cli.nbhood_land_and_sea module
      • process()
    • improver.cli.neighbour_finding module
      • process()
    • improver.cli.normalise_to_reference module
      • process()
    • improver.cli.nowcast_accumulate module
      • name_constraint()
      • process()
    • improver.cli.nowcast_extrapolate module
      • process()
    • improver.cli.nowcast_optical_flow module
      • process()
    • improver.cli.nowcast_optical_flow_from_winds module
      • process()
    • improver.cli.orographic_enhancement module
      • extract_and_check()
      • process()
    • improver.cli.phase_change_level module
      • process()
    • improver.cli.phase_mask module
      • process()
    • improver.cli.phase_probability module
      • process()
    • improver.cli.precipitation_duration module
      • process()
    • improver.cli.recursive_filter module
      • process()
    • improver.cli.regrid module
      • process()
    • improver.cli.relabel_to_period module
      • process()
    • improver.cli.remake_as_shower_condition module
      • process()
    • improver.cli.resolve_wind_components module
      • process()
    • improver.cli.shower_condition_probability module
      • process()
    • improver.cli.sleet_probability module
      • process()
    • improver.cli.snow_fraction module
      • process()
    • improver.cli.snow_splitter module
      • process()
    • improver.cli.spot_extract module
      • process()
    • improver.cli.standardise module
      • process()
    • improver.cli.temp_lapse_rate module
      • process()
    • improver.cli.temporal_interpolate module
      • process()
    • improver.cli.threshold module
      • process()
    • improver.cli.threshold_interpolation module
      • process()
    • improver.cli.time_lagged_ensembles module
      • process()
    • improver.cli.train_quantile_regression_random_forest module
      • process()
    • improver.cli.uv_index module
      • process()
    • improver.cli.vertical_updraught module
      • process()
    • improver.cli.vicinity module
      • process()
    • improver.cli.visibility_combine_cloud_base module
      • process()
    • improver.cli.weather_symbol_modes module
      • process()
    • improver.cli.weighted_blending module
      • process()
    • improver.cli.wet_bulb_freezing_level module
      • process()
    • improver.cli.wet_bulb_temperature module
      • process()
    • improver.cli.wet_bulb_temperature_integral module
      • process()
    • improver.cli.wind_direction module
      • process()
    • improver.cli.wind_downscaling module
      • process()
    • improver.cli.wind_gust_diagnostic module
      • process()
  • Module contents
    • DocutilizeClizeHelp
    • HelpForNapoleonDocstring
      • HelpForNapoleonDocstring.add_docstring()
    • ObjectAsStr
      • ObjectAsStr.obj_to_name()
      • ObjectAsStr.original_object
    • TimeIt
      • TimeIt.elapsed
    • _cli_items()
    • clizefy()
    • comma_separated_list()
    • comma_separated_list_of_float()
    • command_executor()
    • create_constrained_inputcubelist_converter()
    • docutilize()
    • execute_command()
    • improver_help()
    • inputcube()
    • inputcube_nolazy()
    • inputcubelist()
    • inputdatetime()
    • inputjson()
    • inputpath()
    • main()
    • maybe_coerce_with()
    • run_main()
    • unbracket()
    • with_output()
• improver.developer_tools package
  • Submodules
    • improver.developer_tools.metadata_interpreter module
      • CATEGORICAL_MODE_CM()
      • MOMetadataInterpreter
      • _format_standard_cases()
      • display_interpretation()
  • Module contents
• improver.ensemble_copula_coupling package
  • Submodules
    • improver.ensemble_copula_coupling._scipy_continuous_distns module
      • _norm_cdf()
      • _norm_isf()
      • _norm_logpdf()
      • _norm_pdf()
      • _norm_ppf()
      • _norm_sf()
      • truncnorm_gen
    • improver.ensemble_copula_coupling.constants module
      • Bounds
    • improver.ensemble_copula_coupling.ensemble_copula_coupling module
      • ConvertLocationAndScaleParameters
      • ConvertLocationAndScaleParametersToPercentiles
      • ConvertLocationAndScaleParametersToProbabilities
      • ConvertProbabilitiesToPercentiles
      • EnsembleReordering
      • RebadgePercentilesAsRealizations
      • RebadgeRealizationsAsPercentiles
      • ResamplePercentiles
    • improver.ensemble_copula_coupling.numba_utilities module
      • fast_interp_same_x()
      • fast_interp_same_y()
    • improver.ensemble_copula_coupling.utilities module
      • choose_set_of_percentiles()
      • concatenate_2d_array_with_2d_array_endpoints()
      • create_cube_with_percentiles()
      • get_bounds_of_distribution()
      • insert_lower_and_upper_endpoint_to_1d_array()
      • interpolate_multiple_rows_same_x()
      • interpolate_multiple_rows_same_y()
      • restore_non_percentile_dimensions()
      • slow_interp_same_x()
      • slow_interp_same_y()
  • Module contents
• improver.generate_ancillaries package
  • Submodules
    • improver.generate_ancillaries.generate_ancillary module
      • CorrectLandSeaMask
      • GenerateOrographyBandAncils
      • _make_mask_cube()
    • improver.generate_ancillaries.generate_derived_solar_fields module
      • GenerateClearskySolarRadiation
      • GenerateSolarTime
    • improver.generate_ancillaries.generate_distance_to_feature module
      • DistanceTo
    • improver.generate_ancillaries.generate_miscellaneous_ancillaries module
      • generate_distance_to_ocean()
      • generate_distance_to_water()
      • generate_land_area_fraction_at_sites()
      • generate_roughness_length_at_sites()
    • improver.generate_ancillaries.generate_orographic_smoothing_coefficients module
      • OrographicSmoothingCoefficients
    • improver.generate_ancillaries.generate_svp_table module
      • SaturatedVapourPressureTable
    • improver.generate_ancillaries.generate_topographic_zone_weights module
      • GenerateTopographicZoneWeights
  • Module contents
• improver.metadata package
  • Subpackages
    • improver.metadata.constants package
      • Submodules
      • Module contents
  • Submodules
    • improver.metadata.amend module
      • _update_cell_methods()
      • amend_attributes()
      • set_history_attribute()
      • update_diagnostic_name()
      • update_model_id_attr_attribute()
    • improver.metadata.check_datatypes module
      • _is_time_coord()
      • check_dtype()
      • check_mandatory_standards()
      • check_units()
      • enforce_dtype()
      • get_required_dtype()
      • get_required_units()
    • improver.metadata.forecast_times module
      • _calculate_forecast_period()
      • _create_frt_type_coord()
      • _find_latest_cycletime()
      • add_blend_time()
      • forecast_period_coord()
      • rebadge_forecasts_as_latest_cycle()
      • unify_cycletime()
    • improver.metadata.probabilistic module
      • _extract_diagnostic_name()
      • find_percentile_coordinate()
      • find_threshold_coordinate()
      • format_cell_methods_for_diagnostic()
      • format_cell_methods_for_probability()
      • get_diagnostic_cube_name_from_probability_name()
      • get_threshold_coord_name_from_probability_name()
      • in_vicinity_name_format()
      • is_percentile()
      • is_probability()
      • probability_cube_name_regex()
      • probability_is_above_or_below()
    • improver.metadata.utilities module
      • check_grid_match()
      • create_coordinate_hash()
      • create_new_diagnostic_cube()
      • enforce_time_point_standard()
      • generate_hash()
      • generate_mandatory_attributes()
      • get_model_id_attr()
  • Module contents
• improver.nbhood package
  • Submodules
    • improver.nbhood.nbhood module
      • BaseNeighbourhoodProcessing
      • GeneratePercentilesFromANeighbourhood
      • MetaNeighbourhood
      • NeighbourhoodProcessing
      • check_radius_against_distance()
      • circular_kernel()
    • improver.nbhood.recursive_filter module
      • RecursiveFilter
    • improver.nbhood.use_nbhood module
      • ApplyNeighbourhoodProcessingWithAMask
  • Module contents
    • radius_by_lead_time()
• improver.nowcasting package
  • Submodules
    • improver.nowcasting.accumulation module
      • Accumulation
    • improver.nowcasting.forecasting module
      • AdvectField
      • CreateExtrapolationForecast
    • improver.nowcasting.lightning module
      • NowcastLightning
    • improver.nowcasting.optical_flow module
      • OpticalFlow
      • _perturb_background_flow()
      • check_input_coords()
      • generate_advection_velocities_from_winds()
      • generate_optical_flow_components()
    • improver.nowcasting.pysteps_advection module
      • PystepsExtrapolate
    • improver.nowcasting.utilities module
      • ApplyOrographicEnhancement
      • ExtendRadarMask
      • FillRadarHoles
  • Module contents
• improver.precipitation package
  • Submodules
    • improver.precipitation.calculate_sleet_prob module
      • calculate_sleet_probability()
    • improver.precipitation.convection module
      • ConvectionRatioFromComponents
    • improver.precipitation.freezing_rain module
      • FreezingRain
    • improver.precipitation.hail_fraction module
      • HailFraction
    • improver.precipitation.precipitation_duration module
      • PrecipitationDuration
    • improver.precipitation.shower_condition_probability module
      • ShowerConditionProbability
    • improver.precipitation.snow_fraction module
      • SnowFraction
    • improver.precipitation.snow_probability_at_surface module
      • SnowProbabilityAtSurface
    • improver.precipitation.snow_splitter module
      • SnowSplitter
    • improver.precipitation.utilities module
      • make_shower_condition_cube()
  • Module contents
• improver.psychrometric_calculations package
  • Submodules
    • improver.psychrometric_calculations.cloud_condensation_level module
      • CloudCondensationLevel
      • MetaCloudCondensationLevel
    • improver.psychrometric_calculations.cloud_top_temperature module
      • CloudTopTemperature
    • improver.psychrometric_calculations.hail_size module
      • HailSize
    • improver.psychrometric_calculations.precip_phase_probability module
      • PrecipPhaseProbability
    • improver.psychrometric_calculations.precipitable_water module
      • PrecipitableWater
      • ensure_no_float_64()
    • improver.psychrometric_calculations.psychrometric_calculations module
      • HumidityMixingRatio
      • PhaseChangeLevel
      • _calculate_latent_heat()
      • _latent_heat_release()
      • _svp_from_lookup()
      • _svp_table()
      • adjust_for_latent_heat()
      • calculate_svp_in_air()
      • dry_adiabatic_pressure()
      • dry_adiabatic_temperature()
      • saturated_humidity()
    • improver.psychrometric_calculations.significant_phase_mask module
      • SignificantPhaseMask
    • improver.psychrometric_calculations.temperature_saturated_air_parcel module
      • TemperatureSaturatedAirParcel
    • improver.psychrometric_calculations.wet_bulb_temperature module
      • MetaWetBulbFreezingLevel
      • WetBulbTemperature
      • WetBulbTemperatureIntegral
  • Module contents
• improver.regrid package
  • Submodules
    • improver.regrid.bilinear module
      • Bilinear Regridding with Land-sea Mask Awareness
      • adjust_boundary_indexes()
      • adjust_for_surface_mismatch()
      • apply_weights()
      • basic_indexes()
      • basic_weights()
      • lakes_islands()
      • one_mismatched_input_point()
    • improver.regrid.grid module
      • calculate_input_grid_spacing()
      • classify_input_surface_type()
      • classify_output_surface_type()
      • create_regrid_cube()
      • ensure_ascending_coord()
      • flatten_spatial_dimensions()
      • get_cube_coord_names()
      • group_target_points_with_source_domain()
      • latlon_from_cube()
      • latlon_names()
      • mask_target_points_outside_source_domain()
      • similar_surface_classify()
      • slice_cube_by_domain()
      • slice_mask_cube_by_domain()
      • unflatten_spatial_dimensions()
    • improver.regrid.idw module
      • ecef_coords()
      • inverse_distance_weighting()
      • nearest_input_pts()
    • improver.regrid.landsea module
      • AdjustLandSeaPoints
      • RegridLandSea
      • grid_contains_cutout()
    • improver.regrid.landsea2 module
      • RegridWithLandSeaMask
    • improver.regrid.nearest module
      • lakes_islands()
      • nearest_regrid()
      • nearest_with_mask_regrid()
      • update_nearest_points()
  • Module contents
• improver.spotdata package
  • Submodules
    • improver.spotdata.apply_lapse_rate module
      • SpotLapseRateAdjust
      • extract_vertical_displacements()
    • improver.spotdata.build_spotdata_cube module
      • build_spotdata_cube()
    • improver.spotdata.height_adjustment module
      • SpotHeightAdjustment
    • improver.spotdata.neighbour_finding module
      • NeighbourSelection
    • improver.spotdata.spot_extraction module
      • SpotExtraction
    • improver.spotdata.spot_manipulation module
      • SpotManipulation
    • improver.spotdata.utilities module
      • extract_site_json()
      • get_neighbour_finding_method_name()
  • Module contents
• improver.synthetic_data package
  • Submodules
    • improver.synthetic_data.generate_metadata module
      • _create_data_array()
      • _create_time_bounds()
      • _get_units()
      • generate_metadata()
    • improver.synthetic_data.set_up_test_cubes module
      • _construct_dimension_coords()
      • _create_dimension_coord()
      • _create_time_point()
      • _create_yx_arrays()
      • _percentile_cube()
      • _probability_cube()
      • _set_domain_corner()
      • _variable_cube()
      • _yx_for_grid()
      • add_coordinate()
      • construct_scalar_time_coords()
      • construct_yx_coords()
      • set_up_percentile_cube()
      • set_up_probability_cube()
      • set_up_spot_percentile_cube()
      • set_up_spot_probability_cube()
      • set_up_spot_variable_cube()
      • set_up_variable_cube()
    • improver.synthetic_data.utilities module
      • _error_more_than_one_leading_dimension()
      • get_leading_dimension()
      • get_vertical_levels()
  • Module contents
• improver.temperature package
  • Submodules
    • improver.temperature.feels_like_temperature module
      • CalculateWindChill
      • _calculate_apparent_temperature()
      • _feels_like_temperature()
      • calculate_feels_like_temperature()
    • improver.temperature.lapse_rate module
      • ApplyGriddedLapseRate
      • LapseRate
      • compute_lapse_rate_adjustment()
    • improver.temperature.virtual_temperature module
      • VirtualTemperature
  • Module contents
• improver.utilities package
  • Submodules
    • improver.utilities.cli_utilities module
      • load_json_or_none()
      • load_pickle_or_none()
    • improver.utilities.common_input_handle module
      • as_cube()
      • as_cubelist()
      • as_iterable()
    • improver.utilities.compare module
      • compare_attributes()
      • compare_data()
      • compare_datasets()
      • compare_dims()
      • compare_netcdfs()
      • compare_objects()
      • compare_pickled_forest()
      • compare_vars()
    • improver.utilities.complex_conversion module
      • complex_to_deg()
      • deg_to_complex()
    • improver.utilities.copy_metadata module
      • CopyMetadata
    • improver.utilities.cube_checker module
      • assert_spatial_coords_match()
      • assert_time_coords_valid()
      • check_cube_coordinates()
      • check_for_x_and_y_axes()
      • find_dimension_coordinate_mismatch()
      • spatial_coords_match()
    • improver.utilities.cube_constraints module
      • create_sorted_lambda_constraint()
    • improver.utilities.cube_extraction module
      • ExtractLevel
      • ExtractSubCube
      • apply_extraction()
      • create_constraint()
      • cubelist_extract()
      • extract_subcube()
      • parse_constraint_list()
      • parse_range_string_to_dict()
      • thin_cube()
    • improver.utilities.cube_manipulation module
      • MergeCubes
      • add_coordinate_to_cube()
      • clip_cube_data()
      • collapse_realizations()
      • collapse_time()
      • collapsed()
      • compare_attributes()
      • compare_coords()
      • enforce_coordinate_ordering()
      • expand_bounds()
      • filter_realizations()
      • get_coord_names()
      • get_dim_coord_names()
      • get_filtered_attributes()
      • height_of_maximum()
      • manipulate_n_realizations()
      • maximum_in_height()
      • sort_coord_in_cube()
      • strip_var_names()
    • improver.utilities.extract_from_table module
      • ExtractValueFromTable
    • improver.utilities.flatten module
      • flatten()
    • improver.utilities.forecast_reference_enforcement module
      • EnforceConsistentForecasts
      • normalise_to_reference()
      • split_cubes_by_name()
    • improver.utilities.generalized_additive_models module
      • GAMFit
      • GAMPredict
    • improver.utilities.gradient_between_vertical_levels module
      • GradientBetweenVerticalLevels
    • improver.utilities.indexing_operations module
      • choose()
    • improver.utilities.interpolation module
      • InterpolateUsingDifference
      • interpolate_missing_data()
    • improver.utilities.load module
      • load_cube()
      • load_cubelist()
    • improver.utilities.mask module
      • apply_mask()
    • improver.utilities.mathematical_operations module
      • CalculateClimateAnomalies
      • CalculateForecastValueFromClimateAnomaly
      • Integration
      • fast_linear_fit()
      • verify_time_coords_match()
    • improver.utilities.neighbourhood_tools module
      • boxsum()
      • pad_and_roll()
      • pad_boxsum()
      • rolling_window()
    • improver.utilities.pad_spatial module
      • _create_cube_with_padded_data()
      • create_cube_with_halo()
      • pad_coord()
      • pad_cube_with_halo()
      • remove_cube_halo()
      • remove_halo_from_cube()
    • improver.utilities.probability_manipulation module
      • comparison_operator_dict()
      • invert_probabilities()
      • to_threshold_inequality()
    • improver.utilities.redirect_stdout module
      • redirect_stdout()
    • improver.utilities.rescale module
      • apply_double_scaling()
      • rescale()
    • improver.utilities.round module
      • round_close()
    • improver.utilities.save module
      • _check_metadata()
      • _order_cell_methods()
      • save_netcdf()
    • improver.utilities.solar module
      • DayNightMask
      • calc_solar_declination()
      • calc_solar_elevation()
      • calc_solar_hour_angle()
      • calc_solar_time()
      • daynight_terminator()
      • get_day_of_year()
      • get_hour_of_day()
    • improver.utilities.spatial module
      • BaseDistanceCalculator
      • DifferenceBetweenAdjacentGridSquares
      • DistanceBetweenGridSquares
      • GradientBetweenAdjacentGridSquares
      • LatLonCubeDistanceCalculator
      • OccurrenceWithinVicinity
      • ProjectionCubeDistanceCalculator
      • add_vicinity_coordinate()
      • calculate_grid_spacing()
      • check_if_grid_is_equal_area()
      • create_vicinity_coord()
      • distance_to_number_of_grid_cells()
      • get_grid_y_x_values()
      • lat_lon_determine()
      • maximum_within_vicinity()
      • number_of_grid_cells_to_distance()
      • rename_vicinity_cube()
      • transform_grid_to_lat_lon()
      • update_name_and_vicinity_coord()
    • improver.utilities.temporal module
      • cycletime_to_datetime()
      • cycletime_to_number()
      • datetime_constraint()
      • datetime_to_cycletime()
      • datetime_to_iris_time()
      • extract_cube_at_time()
      • extract_nearest_time_point()
      • integrate_time()
      • iris_time_to_datetime()
      • relabel_to_period()
    • improver.utilities.temporal_interpolation module
      • DurationSubdivision
      • TemporalInterpolation
    • improver.utilities.textural module
      • FieldTexture
    • improver.utilities.threshold_interpolation module
      • ThresholdInterpolation
    • improver.utilities.time_lagging module
      • GenerateTimeLaggedEnsemble
  • Module contents
• improver.visibility package
  • Submodules
    • improver.visibility.visibility_combine_cloud_base module
      • VisibilityCombineCloudBase
  • Module contents
• improver.wind_calculations package
  • Submodules
    • improver.wind_calculations.vertical_updraught module
      • VerticalUpdraught
    • improver.wind_calculations.wind_components module
      • ResolveWindComponents
    • improver.wind_calculations.wind_direction module
      • WindDirection
    • improver.wind_calculations.wind_downscaling module
      • FrictionVelocity
      • RoughnessCorrection
      • RoughnessCorrectionUtilities
    • improver.wind_calculations.wind_gust_diagnostic module
      • WindGustDiagnostic
  • Module contents

Submodules

• improver.between_thresholds module
  • OccurrenceBetweenThresholds
    • OccurrenceBetweenThresholds.__init__()
    • OccurrenceBetweenThresholds._abc_impl
    • OccurrenceBetweenThresholds._calculate_probabilities()
    • OccurrenceBetweenThresholds._get_multiplier()
    • OccurrenceBetweenThresholds._slice_cube()
    • OccurrenceBetweenThresholds._update_metadata()
    • OccurrenceBetweenThresholds.process()
• improver.constants module
  • ABSOLUTE_ZERO
  • CP_DRY_AIR
  • CP_WATER_VAPOUR
  • DALR
  • EARTH_REPSILON
  • EARTH_SURFACE_GRAVITY_ACCELERATION
  • ELR
  • LATENT_HEAT_T_DEPENDENCE
  • LH_CONDENSATION_WATER
  • R_DRY_AIR
  • R_DRY_AIR_MOL
  • R_WATER_VAPOUR
  • TRIPLE_PT_WATER
  • WATER_DENSITY
  • WATER_VAPOUR_MOLAR_MASS
• improver.cube_combiner module
  • Combine
    • Combine.__init__()
    • Combine._abc_impl
    • Combine.process()
  • CubeCombiner
    • CubeCombiner.COMBINE_OPERATORS
    • CubeCombiner.__init__()
    • CubeCombiner._abc_impl
    • CubeCombiner._add_cell_method()
    • CubeCombiner._check_dimensions_match()
    • CubeCombiner._combine_cube_data()
    • CubeCombiner._coords_are_broadcastable()
    • CubeCombiner._get_expanded_coord_names()
    • CubeCombiner._setup_coords_for_broadcast()
    • CubeCombiner.process()
  • MaxInTimeWindow
    • MaxInTimeWindow.__init__()
    • MaxInTimeWindow._abc_impl
    • MaxInTimeWindow._check_input_cubes()
    • MaxInTimeWindow._correct_metadata()
    • MaxInTimeWindow._get_coords_in_hours()
    • MaxInTimeWindow.process()
  • masked_add()
• improver.expected_value module
  • ExpectedValue
    • ExpectedValue._abc_impl
    • ExpectedValue.integrate_over_thresholds()
    • ExpectedValue.process()
• improver.grids module
• improver.lightning module
  • LightningFromCapePrecip
    • LightningFromCapePrecip.__init__()
    • LightningFromCapePrecip._abc_impl
    • LightningFromCapePrecip._get_inputs()
    • LightningFromCapePrecip.process()
  • LightningMultivariateProbability_USAF2024
    • LightningMultivariateProbability_USAF2024._abc_impl
    • LightningMultivariateProbability_USAF2024._extract_input()
    • LightningMultivariateProbability_USAF2024._get_inputs()
    • LightningMultivariateProbability_USAF2024.process()
  • latitude_to_threshold()
• improver.memprofile module
  • memory_monitor()
  • memory_profile_decorator()
  • memory_profile_end()
  • memory_profile_start()
• improver.orographic_enhancement module
  • OrographicEnhancement
    • OrographicEnhancement.__init__()
    • OrographicEnhancement._abc_impl
    • OrographicEnhancement._add_upstream_component()
    • OrographicEnhancement._compute_weighted_values()
    • OrographicEnhancement._create_output_cube()
    • OrographicEnhancement._generate_mask()
    • OrographicEnhancement._get_point_distances()
    • OrographicEnhancement._locate_source_points()
    • OrographicEnhancement._orography_gradients()
    • OrographicEnhancement._point_orogenh()
    • OrographicEnhancement._regrid_and_populate()
    • OrographicEnhancement._regrid_variable()
    • OrographicEnhancement.process()
• improver.percentile module
  • PercentileConverter
    • PercentileConverter.__init__()
    • PercentileConverter._abc_impl
    • PercentileConverter.process()
• improver.profile module
  • profile_hook_enable()
  • profile_start()
  • profile_stop()
• improver.standardise module
  • StandardiseMetadata
    • StandardiseMetadata.__init__()
    • StandardiseMetadata._abc_impl
    • StandardiseMetadata._collapse_scalar_dimensions()
    • StandardiseMetadata._discard_redundant_cell_methods()
    • StandardiseMetadata._modify_scalar_coord_value()
    • StandardiseMetadata._remove_air_temperature_status_flag()
    • StandardiseMetadata._remove_long_name_if_standard_name()
    • StandardiseMetadata._remove_scalar_coords()
    • StandardiseMetadata._standardise_dtypes_and_units()
    • StandardiseMetadata.process()
• improver.threshold module
  • LatitudeDependentThreshold
    • LatitudeDependentThreshold.__init__()
    • LatitudeDependentThreshold._abc_impl
    • LatitudeDependentThreshold._add_latitude_threshold_coord()
    • LatitudeDependentThreshold.process()
  • Threshold
    • Threshold.__init__()
    • Threshold._abc_impl
    • Threshold._add_threshold_coord()
    • Threshold._calculate_truth_value()
    • Threshold._check_fuzzy_bounds()
    • Threshold._create_threshold_cube()
    • Threshold._decode_comparison_operator_string()
    • Threshold._generate_fuzzy_bounds()
    • Threshold._set_thresholds()
    • Threshold._update_metadata()
    • Threshold._vicinity_processing()
    • Threshold.process()
• improver.uv_index module
  • calculate_uv_index()

Module contents

Module containing plugin base class.

class BasePlugin

Bases: ABC

An abstract class for IMPROVER plugins. Subclasses must be callable. We preserve the process method by redirecting to __call__.

_abc_impl = <_abc._abc_data object>

abstract process(*args, **kwargs)

Abstract class for rest to implement.

class PostProcessingPlugin

Bases: BasePlugin

An abstract class for IMPROVER post-processing plugins. Makes generalised changes to metadata relating to post-processing.

_abc_impl = <_abc._abc_data object>

static post_processed_title(cube)

Updates title attribute on output cube to include “Post-Processed”

test_data_path(*path_to_join)

Function to generate the path to the data within the improver_test_data repo from the relative path provided.

Raises:

ImportError – The improver_tests_data package is not available

Returns:

An absolute path to the sample data.