Index

A

ActivityPlot (class in rook.dashboard.plots.activity) add() (rook.operations.normalise.ResultSet method) add_coord() (in module rook.utils.data_utils.coord_utils) add_data_var() (in module rook.utils.data_utils.var_utils) add_global_attrs_if_needed() (in module rook.utils.data_utils.attr_utils) add_operator() (rook.provenance.Provenance method) add_project_id() (in module rook.utils.atlas_fixes) add_scalar_coord() (in module rook.utils.data_utils.coord_utils) AddressValueError aligned_original_file_urls() (in module rook.pflow.resolver) aligned_subset_decision() (in module rook.pflow.resolver) apply_atlas_fixes() (in module rook.utils.atlas_fixes) apply_concat_calendar_fix() (in module rook.operations.concat) apply_concat_dataset_fixes() (in module rook.operations.concat) apply_dataset_fix_policy() (in module rook.io.datasets) apply_decadal_fixes() (in module rook.utils.decadal_fixes) apply_fixes() (in module rook.utils.apply_fixes) Average (class in rook.operations) (class in rook.operations.average)

average_dimension_operator() (in module rook.operations.execution) average_over_dims() (in module rook.operations.average) average_shape() (in module rook.operations.average) average_shape_operator() (in module rook.operations.execution) average_time() (in module rook.operations.average) average_time_operator() (in module rook.operations.execution) AverageByDimension (class in rook.processes.wps_average_dim) AverageByDimension() (in module rook.operations) (in module rook.operations.execution) AverageByShape (class in rook.processes.wps_average_shape) AverageByShape() (in module rook.operations) (in module rook.operations.execution) AverageByTime (class in rook.processes.wps_average_time) AverageByTime() (in module rook.operations) (in module rook.operations.execution) AverageShape (class in rook.operations) AverageTime (class in rook.operations)

B

BaseView (class in rook.dashboard.base) BaseWorkflow (class in rook.workflow)

build_metalink() (in module rook.utils.metalink_utils) build_tree() (in module rook.workflow)

C

calc_weighted_mean() (in module rook.utils.weighted_average_utils) calculate() (rook.operations.base.Operation method) (rook.operations.concat.Concat method) (rook.operations.Operation method) call() (rook.operations.execution.Operator method) (rook.operations.Operator method) Catalog (class in rook.catalog.base) catalog (rook.catalog.intake.IntakeCatalog property) catalog_for() (in module rook.pflow.catalog) CatalogCollection (class in rook.pflow) (class in rook.pflow.sources) classify_request_source() (in module rook.pflow.resolver) clean_inputs() (in module rook.utils.input_utils) collect() (rook.usage.base.Usage method) (rook.usage.combine.Combine method) (rook.usage.downloads.Downloads method) (rook.usage.wpsusage.WPSUsage method) collect_file_uris() (in module rook.operations.execution) collect_original_file_uris() (in module rook.pflow.execution) collection (rook.pflow.CatalogCollection attribute) (rook.pflow.DirectDataset attribute) (rook.pflow.sources.CatalogCollection attribute) (rook.pflow.sources.DirectDataset attribute)

Combine (class in rook.usage.combine) combine_concat_datasets() (in module rook.operations.concat) components() (rook.dashboard.plots.base.PlotView method) (rook.dashboard.tables.base.TableView method) Concat (class in rook.operations.concat) (class in rook.processes.wps_concat) Concat() (in module rook.operations) concat() (in module rook.operations.concat) Concat() (in module rook.operations.execution) concat_dimension() (in module rook.operations.concat) concat_operator() (in module rook.operations.execution) ConcatOperation (in module rook.operations) ConcurrencyPlot (class in rook.dashboard.plots.concurrency) concurrent_requests() (in module rook.dashboard.models) ConfigurationError consolidate() (in module rook.operations.consolidate) convert_calendar_to_gregorian() (in module rook.utils.fixes_utils) create_app() (in module rook.wsgi)

D

Dashboard (class in rook.dashboard.dashboard) DashboardProcess (class in rook.processes.wps_dashboard) data() (in module rook.dashboard.plots.activity2) (rook.dashboard.base.BaseView method) (rook.dashboard.plots.activity.ActivityPlot method) (rook.dashboard.plots.concurrency.ConcurrencyPlot method) (rook.dashboard.plots.day.DayPlot method) (rook.dashboard.plots.downloads.DownloadsPlot method) (rook.dashboard.plots.duration.DurationPlot method) (rook.dashboard.plots.hour.HourPlot method) (rook.dashboard.plots.pulse.PulsePlot method) (rook.dashboard.plots.transfer.TransferPlot method) (rook.dashboard.tables.messages.MessageTable method) (rook.dashboard.tables.overview.OverviewTable method) dataset_id (rook.io.datasets.DatasetSource attribute) (rook.io.DatasetSource attribute) dataset_paths_by_id() (in module rook.operations.concat) dataset_sources (rook.pflow.decisions.ReturnOriginalFiles property) (rook.pflow.decisions.RunOperation attribute) (rook.pflow.RequestResult property) (rook.pflow.results.RequestResult property) (rook.pflow.ReturnOriginalFiles property) (rook.pflow.RunOperation attribute) dataset_sources_from_search() (in module rook.pflow.catalog) DatasetFormat (class in rook.io) (class in rook.io.datasets)

DatasetSource (class in rook.io) (class in rook.io.datasets) DayPlot (class in rook.dashboard.plots.day) DBCatalog (class in rook.catalog) (class in rook.catalog.db) decadal_fix_1() (in module rook.utils.decadal_fixes) decadal_fix_2() (in module rook.utils.decadal_fixes) decadal_fix_3() (in module rook.utils.decadal_fixes) decadal_fix_4() (in module rook.utils.decadal_fixes) decadal_fix_5() (in module rook.utils.decadal_fixes) decadal_fix_calendar() (in module rook.utils.decadal_fixes) decision (rook.pflow.RequestResult attribute) (rook.pflow.results.RequestResult attribute) DecisionExecutor (class in rook.pflow.base) detect_format() (in module rook.io.datasets) detect_transport() (in module rook.io.datasets) DirectDataset (class in rook.pflow) (class in rook.pflow.sources) dot2longip() (in module rook.usage.downloads) download_urls() (rook.catalog.base.Result method) Downloads (class in rook.usage.downloads) DownloadsPlot (class in rook.dashboard.plots.downloads) drop_time_bnds() (in module rook.operations.concat) dump_json() (rook.provenance.Provenance method) DurationPlot (class in rook.dashboard.plots.duration)

E

edit_global_attrs() (in module rook.utils.data_utils.attr_utils) edit_var_attrs() (in module rook.utils.data_utils.attr_utils) execute() (rook.pflow.base.DecisionExecutor method) execute_decision() (in module rook.pflow.execution)

execute_request() (in module rook.pflow.execution) execute_resolved_request() (in module rook.pflow) exists() (rook.catalog.db.DBCatalog method) (rook.catalog.DBCatalog method) extract_paths_from_metalink() (in module rook.utils.metalink_utils)

F

files (rook.pflow.sources.WorkflowFiles attribute) (rook.pflow.WorkflowFiles attribute) files() (rook.catalog.base.Result method) FILESYSTEM (rook.io.datasets.Transport attribute) (rook.io.Transport attribute)

finalise_concat_output() (in module rook.operations.concat) fix_deflation() (in module rook.utils.atlas_fixes) fix_parameters() (in module rook.utils.input_utils) fix_time_components() (in module rook.utils.input_utils) format_time() (in module rook.usage.combine)

G

get_catalog() (in module rook.catalog) get_config() (in module rook.config) get_decadal_model_attr_from_dict() (in module rook.utils.decadal_fixes) get_files_matching_time_range() (in module rook.operations.consolidate) get_grid_param() (in module rook.utils.input_utils) get_host() (in module rook.cli) get_lead_times() (in module rook.utils.decadal_utils) get_operation_callable() (rook.operations.Average method) (rook.operations.average.Average method) (rook.operations.AverageShape method) (rook.operations.AverageTime method) (rook.operations.base.Operation method) (rook.operations.Operation method) (rook.operations.regrid.Regrid method) (rook.operations.subset.Subset method)

get_project_config() (in module rook.config) get_provn() (rook.provenance.Provenance method) get_reftime() (in module rook.utils.decadal_utils) get_s3_storage_options() (in module rook.config) get_start_date() (in module rook.utils.decadal_utils) get_storage_base() (in module rook.config) get_storage_options() (in module rook.io.datasets) get_sub_experiment_id() (in module rook.utils.decadal_utils) get_time_calendar() (in module rook.utils.decadal_utils) get_usage() (in module rook.usage.combine) get_year() (in module rook.operations.consolidate) get_years_from_file() (in module rook.operations.consolidate)

H

handle_derive_str() (in module rook.utils.data_utils.common_utils) has_processing_required_input() (in module rook.pflow.policies) HourPlot (class in rook.dashboard.plots.hour)

HTTP (rook.io.datasets.Transport attribute) (rook.io.Transport attribute) http_log_path (rook.usage.downloads.Downloads property)

I

identifier (rook.provenance.Provenance property) IntakeCatalog (class in rook.catalog.intake) InvalidRequest (class in rook.pflow) (class in rook.pflow.decisions)

is_file() (in module rook.workflow) is_kerchunk_file() (in module rook.io.datasets) is_prepared_dataset_collection() (in module rook.operations.base) is_zarr_store() (in module rook.io.datasets)

J

json() (rook.provenance.Provenance method)

K

keep_dataset() (in module rook.operations.normalise) KERCHUNK (rook.io.DatasetFormat attribute) (rook.io.datasets.DatasetFormat attribute)

key (rook.io.datasets.DatasetSource property) (rook.io.DatasetSource property)

L

load() (rook.catalog.intake.IntakeCatalog method) (rook.dashboard.dashboard.Dashboard method)

load_downloads() (rook.dashboard.dashboard.Dashboard method) load_wfdoc() (in module rook.workflow)

M

make_list() (in module rook.catalog.base) make_workflow_operator() (in module rook.operations) (in module rook.operations.execution) matches (rook.catalog.base.Result property) may_return_original_files() (in module rook.pflow.policies) message (rook.pflow.decisions.InvalidRequest attribute) (rook.pflow.InvalidRequest attribute) MessageTable (class in rook.dashboard.tables.messages) module rook rook.__version__ rook.catalog rook.catalog.base rook.catalog.db rook.catalog.intake rook.catalog.util rook.cli rook.config rook.dashboard rook.dashboard.base rook.dashboard.dashboard rook.dashboard.models rook.dashboard.plots rook.dashboard.plots.activity rook.dashboard.plots.activity2 rook.dashboard.plots.base rook.dashboard.plots.concurrency rook.dashboard.plots.day rook.dashboard.plots.downloads rook.dashboard.plots.duration rook.dashboard.plots.hour rook.dashboard.plots.pulse rook.dashboard.plots.transfer rook.dashboard.tables rook.dashboard.tables.base rook.dashboard.tables.messages rook.dashboard.tables.overview rook.exceptions rook.io rook.io.datasets rook.operations rook.operations.average rook.operations.base rook.operations.concat rook.operations.consolidate rook.operations.execution rook.operations.normalise rook.operations.processor rook.operations.regrid rook.operations.subset rook.pflow rook.pflow.alignment rook.pflow.base rook.pflow.catalog rook.pflow.decisions rook.pflow.execution rook.pflow.policies rook.pflow.resolver rook.pflow.results rook.pflow.sources rook.processes rook.processes.wps_average_dim rook.processes.wps_average_shape rook.processes.wps_average_time rook.processes.wps_average_weighted rook.processes.wps_concat rook.processes.wps_dashboard rook.processes.wps_orchestrate rook.processes.wps_regrid rook.processes.wps_subset rook.processes.wps_usage rook.provenance rook.rook rook.usage rook.usage.base rook.usage.combine rook.usage.downloads rook.usage.wpsusage rook.utils rook.utils.apply_fixes rook.utils.atlas_fixes rook.utils.data_utils rook.utils.data_utils.attr_utils rook.utils.data_utils.common_utils rook.utils.data_utils.coord_utils rook.utils.data_utils.var_utils rook.utils.decadal_fixes rook.utils.decadal_utils rook.utils.fixes_utils rook.utils.input_utils rook.utils.metalink_utils rook.utils.response_utils rook.utils.weighted_average_utils rook.workflow rook.wsgi

N

NETCDF (rook.io.DatasetFormat attribute) (rook.io.datasets.DatasetFormat attribute)

normalise() (in module rook.operations.normalise) normalise_file_groups() (in module rook.operations.normalise) NotFoundError

O

open_dataset() (in module rook.io) (in module rook.io.datasets) open_kerchunk() (in module rook.io.datasets) open_netcdf() (in module rook.io.datasets) open_zarr() (in module rook.io.datasets) Operation (class in rook.operations) (class in rook.operations.base) operation_decision() (in module rook.pflow.resolver) Operator (class in rook.operations) (class in rook.operations.execution) Orchestrate (class in rook.processes.wps_orchestrate) original_file_urls (rook.pflow.decisions.ReturnOriginalFiles attribute) (rook.pflow.decisions.RunOperation property) (rook.pflow.RequestResult property) (rook.pflow.results.RequestResult property) (rook.pflow.ReturnOriginalFiles attribute) (rook.pflow.RunOperation property)

original_files_decision() (in module rook.pflow.resolver) OTHER (rook.io.datasets.Transport attribute) (rook.io.Transport attribute) output_path (rook.usage.downloads.Downloads property) output_uris (rook.pflow.RequestResult attribute) (rook.pflow.results.RequestResult attribute) OverviewTable (class in rook.dashboard.tables.overview)

P

parse() (rook.usage.downloads.Downloads method) parse_custom_grid() (in module rook.utils.input_utils) parse_metalink() (in module rook.utils.metalink_utils) parse_record() (in module rook.usage.downloads) parse_time() (in module rook.catalog.util) parse_wps_input() (in module rook.utils.input_utils) paths (rook.io.datasets.DatasetSource attribute) (rook.io.DatasetSource attribute) plot() (in module rook.dashboard.plots.activity2) (rook.dashboard.plots.activity.ActivityPlot method) (rook.dashboard.plots.base.PlotView method) (rook.dashboard.plots.concurrency.ConcurrencyPlot method) (rook.dashboard.plots.day.DayPlot method) (rook.dashboard.plots.downloads.DownloadsPlot method) (rook.dashboard.plots.duration.DurationPlot method) (rook.dashboard.plots.hour.HourPlot method) (rook.dashboard.plots.pulse.PulsePlot method) (rook.dashboard.plots.transfer.TransferPlot method) PlotView (class in rook.dashboard.plots.base)

populate_response() (in module rook.utils.response_utils) prefix (rook.operations.execution.WorkflowOperation attribute) prepare_operation_inputs() (in module rook.pflow.execution) prepare_workflow_file_inputs() (in module rook.operations.execution) PreparedCollection (class in rook.operations.base) process() (in module rook.operations.processor) project (rook.pflow.CatalogCollection attribute) (rook.pflow.decisions.ReturnOriginalFiles attribute) (rook.pflow.decisions.RunOperation attribute) (rook.pflow.DirectDataset attribute) (rook.pflow.RequestResult property) (rook.pflow.results.RequestResult property) (rook.pflow.ReturnOriginalFiles attribute) (rook.pflow.RunOperation attribute) (rook.pflow.sources.CatalogCollection attribute) (rook.pflow.sources.DirectDataset attribute) project_returns_original_files() (in module rook.pflow.policies) Provenance (class in rook.provenance) provenance (rook.workflow.WorkflowRunner property) PulsePlot (class in rook.dashboard.plots.pulse)

R

REFERENCE (rook.io.datasets.Transport attribute) (rook.io.Transport attribute) Regrid (class in rook.operations.regrid) (class in rook.processes.wps_regrid) Regrid() (in module rook.operations) (in module rook.operations.execution) regrid() (in module rook.operations.regrid) regrid_operator() (in module rook.operations.execution) RegridOperation (in module rook.operations) reload_config() (in module rook.config) remove_coord_attr() (in module rook.utils.data_utils.attr_utils) render() (rook.dashboard.dashboard.Dashboard method) replace_inputs() (in module rook.workflow) RequestDecision (class in rook.pflow.base) RequestPolicy (class in rook.pflow.base) RequestResolver (class in rook.pflow.base) RequestResult (class in rook.pflow) (class in rook.pflow.results) requests_original_files() (in module rook.pflow.policies) RequestSource (class in rook.pflow.base) requires_processing() (in module rook.pflow.policies) resolve() (rook.pflow.base.RequestResolver method) resolve_catalog_collection() (in module rook.pflow.resolver) resolve_catalog_search() (in module rook.pflow.catalog) resolve_collection() (in module rook.operations.base) resolve_project() (in module rook.pflow.resolver) resolve_request_decision() (in module rook.pflow) (in module rook.pflow.resolver) resolve_to_file_paths() (in module rook.utils.input_utils) Result (class in rook.catalog.base) ResultSet (class in rook.operations.normalise) ReturnOriginalFiles (class in rook.pflow) (class in rook.pflow.decisions) returns_original_files (rook.pflow.base.RequestDecision property) (rook.pflow.decisions.InvalidRequest property) (rook.pflow.decisions.ReturnOriginalFiles property) (rook.pflow.decisions.RunOperation property) (rook.pflow.InvalidRequest property) (rook.pflow.ReturnOriginalFiles property) (rook.pflow.RunOperation property) rook module rook.__version__ module rook.catalog module rook.catalog.base module rook.catalog.db module rook.catalog.intake module rook.catalog.util module rook.cli module rook.config module rook.dashboard module rook.dashboard.base module rook.dashboard.dashboard module rook.dashboard.models module rook.dashboard.plots module rook.dashboard.plots.activity module rook.dashboard.plots.activity2 module rook.dashboard.plots.base module rook.dashboard.plots.concurrency module rook.dashboard.plots.day module rook.dashboard.plots.downloads module rook.dashboard.plots.duration module rook.dashboard.plots.hour module rook.dashboard.plots.pulse module rook.dashboard.plots.transfer module rook.dashboard.tables module rook.dashboard.tables.base module rook.dashboard.tables.messages module rook.dashboard.tables.overview module rook.exceptions module rook.io module rook.io.datasets module rook.operations module rook.operations.average module rook.operations.base module rook.operations.concat module rook.operations.consolidate module rook.operations.execution module rook.operations.normalise module rook.operations.processor module

rook.operations.regrid module rook.operations.subset module rook.pflow module rook.pflow.alignment module rook.pflow.base module rook.pflow.catalog module rook.pflow.decisions module rook.pflow.execution module rook.pflow.policies module rook.pflow.resolver module rook.pflow.results module rook.pflow.sources module rook.processes module rook.processes.wps_average_dim module rook.processes.wps_average_shape module rook.processes.wps_average_time module rook.processes.wps_average_weighted module rook.processes.wps_concat module rook.processes.wps_dashboard module rook.processes.wps_orchestrate module rook.processes.wps_regrid module rook.processes.wps_subset module rook.processes.wps_usage module rook.provenance module rook.rook module rook.usage module rook.usage.base module rook.usage.combine module rook.usage.downloads module rook.usage.wpsusage module rook.utils module rook.utils.apply_fixes module rook.utils.atlas_fixes module rook.utils.data_utils module rook.utils.data_utils.attr_utils module rook.utils.data_utils.common_utils module rook.utils.data_utils.coord_utils module rook.utils.data_utils.var_utils module rook.utils.decadal_fixes module rook.utils.decadal_utils module rook.utils.fixes_utils module rook.utils.input_utils module rook.utils.metalink_utils module rook.utils.response_utils module rook.utils.weighted_average_utils module rook.workflow module rook.wsgi module run() (rook.workflow.BaseWorkflow method) (rook.workflow.WorkflowRunner method) run_average_by_dim() (in module rook.operations) (in module rook.operations.execution) run_average_by_shape() (in module rook.operations) (in module rook.operations.execution) run_average_by_time() (in module rook.operations) (in module rook.operations.execution) run_concat() (in module rook.operations) (in module rook.operations.execution) run_operation() (in module rook.pflow.execution) run_process_action() (in module rook.cli) run_regrid() (in module rook.operations) (in module rook.operations.execution) run_subset() (in module rook.operations) (in module rook.operations.execution) run_weighted_average() (in module rook.operations) (in module rook.utils.weighted_average_utils) run_workflow_files() (in module rook.operations.execution) runner (rook.operations.execution.WorkflowOperation attribute) RunOperation (class in rook.pflow) (class in rook.pflow.decisions)

S

S3 (rook.io.datasets.Transport attribute) (rook.io.Transport attribute) search() (rook.catalog.base.Catalog method) search_result (rook.pflow.decisions.ReturnOriginalFiles attribute) (rook.pflow.decisions.RunOperation attribute) (rook.pflow.RequestResult property) (rook.pflow.results.RequestResult property) (rook.pflow.ReturnOriginalFiles attribute) (rook.pflow.RunOperation attribute) should_apply_dataset_fixes() (in module rook.io.datasets)

squeeze_dims() (in module rook.utils.data_utils.coord_utils) start() (rook.provenance.Provenance method) stop() (rook.provenance.Provenance method) Subset (class in rook.operations.subset) (class in rook.processes.wps_subset) Subset() (in module rook.operations) (in module rook.operations.execution) subset() (in module rook.operations.subset) subset_operator() (in module rook.operations.execution) SubsetAlignmentChecker (class in rook.pflow.alignment) SubsetOperation (in module rook.operations)

T

table() (rook.dashboard.tables.base.TableView method) (rook.dashboard.tables.messages.MessageTable method) (rook.dashboard.tables.overview.OverviewTable method) TableView (class in rook.dashboard.tables.base) to_db() (rook.catalog.db.DBCatalog method) (rook.catalog.DBCatalog method)

to_year() (in module rook.operations.consolidate) TransferPlot (class in rook.dashboard.plots.transfer) Transport (class in rook.io) (class in rook.io.datasets)

U

update() (rook.catalog.db.DBCatalog method) (rook.catalog.DBCatalog method) Usage (class in rook.processes.wps_usage) (class in rook.usage.base)

use_original_files (rook.pflow.RequestResult property) (rook.pflow.results.RequestResult property) uses_catalog() (in module rook.pflow.resolver)

V

validate() (rook.workflow.BaseWorkflow method) (rook.workflow.Workflow method)

validate_search_result() (in module rook.pflow.catalog) value (rook.operations.base.PreparedCollection attribute)

W

weighted_average_operator() (in module rook.operations.execution) WeightedAverage (class in rook.processes.wps_average_weighted) WeightedAverage() (in module rook.operations) (in module rook.operations.execution) WeightedAverage_ (class in rook.utils.weighted_average_utils) Workflow (class in rook.workflow) WorkflowFiles (class in rook.pflow) (class in rook.pflow.sources)

WorkflowOperation (class in rook.operations.execution) WorkflowRunner (class in rook.workflow) WorkflowValidationError WPSUsage (class in rook.usage.wpsusage) write() (rook.dashboard.dashboard.Dashboard method) write_json() (rook.provenance.Provenance method) write_png() (rook.provenance.Provenance method) write_user_config() (in module rook.cli)

Z

ZARR (rook.io.DatasetFormat attribute) (rook.io.datasets.DatasetFormat attribute)