rook.utils package

Subpackages

• rook.utils.data_utils package
  • Submodules
  • rook.utils.data_utils.attr_utils module
    • add_global_attrs_if_needed()
    • edit_global_attrs()
    • edit_var_attrs()
    • remove_coord_attr()
  • rook.utils.data_utils.common_utils module
    • handle_derive_str()
  • rook.utils.data_utils.coord_utils module
    • add_coord()
    • add_scalar_coord()
    • squeeze_dims()
  • rook.utils.data_utils.var_utils module
    • add_data_var()
• rook.utils.ops package
  • Average
    • Average.get_operation_callable()
  • Concat
  • Operation
    • Operation.calculate()
    • Operation.get_operation_callable()
  • Regrid
    • Regrid.get_operation_callable()
  • ResultSet
    • ResultSet.add()
  • Subset
    • Subset.calculate()
  • average_over_dims()
  • average_shape()
  • average_time()
  • Submodules
  • rook.utils.ops.average module
    • Average
      • Average.get_operation_callable()
    • average_over_dims()
    • average_shape()
    • average_time()
  • rook.utils.ops.base module
    • Operation
      • Operation.calculate()
      • Operation.get_operation_callable()
  • rook.utils.ops.concat module
    • Concat
    • concat()
    • drop_time_bnds()
    • patched_normalise()
  • rook.utils.ops.consolidate module
    • consolidate()
    • get_files_matching_time_range()
    • get_year()
    • get_years_from_file()
    • to_year()
  • rook.utils.ops.helpers module
    • open_dataset()
    • ordered_dict()
    • wrap_sequence()
  • rook.utils.ops.normalise module
    • ResultSet
      • ResultSet.add()
    • normalise()
  • rook.utils.ops.processor module
    • dispatch()
    • process()
  • rook.utils.ops.regrid module
    • Regrid
      • Regrid.get_operation_callable()
    • regrid()
  • rook.utils.ops.subset module
    • Subset
      • Subset.calculate()
    • subset()

Submodules

rook.utils.apply_fixes module

rook.utils.apply_fixes.apply_fixes(dset, ds)

rook.utils.atlas_fixes module

rook.utils.atlas_fixes.add_project_id(ds_id, ds)

rook.utils.atlas_fixes.apply_atlas_fixes(ds_id, ds)

rook.utils.atlas_fixes.fix_deflation(ds: Dataset | DataArray)

See also: clisops.ops.base_operation._remove_redundant_fill_values.

rook.utils.average_utils module

rook.utils.average_utils.run_average_by_dim(args)

rook.utils.average_utils.run_average_by_shape(args)

rook.utils.average_utils.run_average_by_time(args)

rook.utils.concat_utils module

rook.utils.concat_utils.run_concat(args)

rook.utils.decadal_fixes module

rook.utils.decadal_fixes.apply_decadal_fixes(ds_id, ds, output_dir=None)

rook.utils.decadal_fixes.decadal_fix_1(ds_id, ds)

rook.utils.decadal_fixes.decadal_fix_2(ds_id, ds)

rook.utils.decadal_fixes.decadal_fix_3(ds_id, ds)

rook.utils.decadal_fixes.decadal_fix_4(ds_id, ds)

rook.utils.decadal_fixes.decadal_fix_5(ds_id, ds)

rook.utils.decadal_fixes.decadal_fix_calendar(ds_id, ds, output_dir=None)

rook.utils.decadal_fixes.get_decadal_model_attr_from_dict(ds_id, ds, attr)

rook.utils.decadal_utils module

Utility functions for fixing decadal datasets.

rook.utils.decadal_utils.get_lead_times(ds_id, ds)

Get lead times in days relative to forecast reference time.

rook.utils.decadal_utils.get_reftime(ds_id, ds)

Get reference time for decadal forecast.

rook.utils.decadal_utils.get_start_date(ds_id, ds)

Get start date inferred from decadal dataset id.

rook.utils.decadal_utils.get_sub_experiment_id(ds_id, ds)

Get sub-experiment identifier from start date.

rook.utils.decadal_utils.get_time_calendar(ds_id, ds)

Get the calendar from the dataset time axis.

rook.utils.fixes_utils module

rook.utils.fixes_utils.convert_calendar_to_gregorian(ds: Dataset, reference_date='1850-01-01') → Dataset

Convert a Dataset from proleptic_gregorian to gregorian calendar, including time_bnds if present.

Parameters:

• (xarray.Dataset) (- ds)

• (str) (- reference_date)

Returns:

- xarray.Dataset

Return type:

A new dataset with calendar set to ‘gregorian’.

rook.utils.input_utils module

rook.utils.input_utils.clean_inputs(inputs)

Remove common arguments not required in processing calls.

rook.utils.input_utils.fix_parameters(parameters)

rook.utils.input_utils.fix_time_components(tc)

rook.utils.input_utils.get_grid_param(grid: str, custom_grid: str | None)

rook.utils.input_utils.parse_custom_grid(grid_str: str)

Parse the custom grid string into a tuple/list for clisops regrid.

Allowed lengths: 1, 2, 3, 6.

rook.utils.input_utils.parse_wps_input(inputs, key, as_sequence=False, must_exist=False, default=None)

rook.utils.input_utils.resolve_to_file_paths(coll)

rook.utils.metalink_utils module

rook.utils.metalink_utils.build_metalink(identity, description, workdir, file_uris, file_type='NetCDF')

rook.utils.metalink_utils.extract_paths_from_metalink(path)

rook.utils.metalink_utils.parse_metalink(xml)

rook.utils.regrid_utils module

rook.utils.regrid_utils.run_regrid(args)

rook.utils.response_utils module

rook.utils.response_utils.populate_response(response, label, workdir, inputs, collection, ml4)

rook.utils.subset_utils module

rook.utils.subset_utils.run_subset(args)

rook.utils.weighted_average_utils module

class rook.utils.weighted_average_utils.WeightedAverage_(ds, file_namer: str = 'standard', split_method: str = 'time:auto', output_dir: str | Path | None = None, output_type: str = 'netcdf', **params)

Bases: Average

rook.utils.weighted_average_utils.calc_weighted_mean(ds)

rook.utils.weighted_average_utils.run_weighted_average(args)