rook package

A WPS service for roocs.

class rook.Package

Bases: object

Subpackages

• rook.catalog package
  • DBCatalog
    • DBCatalog.exists()
    • DBCatalog.to_db()
    • DBCatalog.update()
  • get_catalog()
  • Submodules
  • rook.catalog.base module
    • Catalog
      • Catalog.search()
    • Result
      • Result.download_urls()
      • Result.files()
      • Result.matches
    • make_list()
  • rook.catalog.db module
    • DBCatalog
      • DBCatalog.exists()
      • DBCatalog.to_db()
      • DBCatalog.update()
  • rook.catalog.intake module
    • IntakeCatalog
      • IntakeCatalog.catalog
      • IntakeCatalog.load()
  • rook.catalog.util module
    • parse_time()
• rook.dashboard package
  • Subpackages
    • rook.dashboard.plots package
      • Submodules
      • 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 package
      • Submodules
      • rook.dashboard.tables.base module
      • rook.dashboard.tables.messages module
      • rook.dashboard.tables.overview module
  • Submodules
  • rook.dashboard.base module
    • BaseView
      • BaseView.data()
  • rook.dashboard.dashboard module
    • Dashboard
      • Dashboard.load()
      • Dashboard.load_downloads()
      • Dashboard.render()
      • Dashboard.write()
  • rook.dashboard.models module
    • concurrent_requests()
• rook.director package
  • Submodules
  • rook.director.alignment module
    • SubsetAlignmentChecker
  • rook.director.compat module
    • ResultSet
      • ResultSet.add()
    • is_characterised()
  • rook.director.director module
    • Director
      • Director.process()
      • Director.request_aligns_with_files()
      • Director.requires_fixes()
      • Director.use_fixes()
    • wrap_director()
• rook.processes package
  • Submodules
  • rook.processes.wps_average_dim module
    • AverageByDimension
  • rook.processes.wps_average_shape module
    • AverageByShape
  • rook.processes.wps_average_time module
    • AverageByTime
  • rook.processes.wps_average_weighted module
    • WeightedAverage
  • rook.processes.wps_concat module
    • Concat
  • rook.processes.wps_dashboard module
    • DashboardProcess
  • rook.processes.wps_orchestrate module
    • Orchestrate
  • rook.processes.wps_regrid module
    • Regrid
  • rook.processes.wps_subset module
    • Subset
  • rook.processes.wps_usage module
    • Usage
• rook.usage package
  • Submodules
  • rook.usage.base module
    • Usage
      • Usage.collect()
  • rook.usage.combine module
    • Combine
      • Combine.collect()
    • format_time()
    • get_usage()
  • rook.usage.downloads module
    • AddressValueError
    • Downloads
      • Downloads.collect()
      • Downloads.http_log_path
      • Downloads.output_path
      • Downloads.parse()
    • NotFoundError
    • dot2longip()
    • parse_record()
  • rook.usage.wpsusage module
    • WPSUsage
      • WPSUsage.collect()
• rook.utils package
  • Subpackages
    • rook.utils.data_utils package
      • Submodules
      • 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.ops package
      • Average
      • Concat
      • Operation
      • Regrid
      • ResultSet
      • Subset
      • average_over_dims()
      • average_shape()
      • average_time()
      • Submodules
      • rook.utils.ops.average module
      • rook.utils.ops.base module
      • rook.utils.ops.concat module
      • rook.utils.ops.consolidate module
      • rook.utils.ops.helpers module
      • rook.utils.ops.normalise module
      • rook.utils.ops.processor module
      • rook.utils.ops.regrid module
      • rook.utils.ops.subset module
  • Submodules
  • rook.utils.apply_fixes module
    • apply_fixes()
  • rook.utils.atlas_fixes module
    • add_project_id()
    • apply_atlas_fixes()
    • fix_deflation()
  • rook.utils.average_utils module
    • run_average_by_dim()
    • run_average_by_shape()
    • run_average_by_time()
  • rook.utils.concat_utils module
    • run_concat()
  • rook.utils.decadal_fixes module
    • apply_decadal_fixes()
    • decadal_fix_1()
    • decadal_fix_2()
    • decadal_fix_3()
    • decadal_fix_4()
    • decadal_fix_5()
    • decadal_fix_calendar()
    • get_decadal_model_attr_from_dict()
  • rook.utils.decadal_utils module
    • get_lead_times()
    • get_reftime()
    • get_start_date()
    • get_sub_experiment_id()
    • get_time_calendar()
  • rook.utils.fixes_utils module
    • convert_calendar_to_gregorian()
  • rook.utils.input_utils module
    • clean_inputs()
    • fix_parameters()
    • fix_time_components()
    • get_grid_param()
    • parse_custom_grid()
    • parse_wps_input()
    • resolve_to_file_paths()
  • rook.utils.metalink_utils module
    • build_metalink()
    • extract_paths_from_metalink()
    • parse_metalink()
  • rook.utils.regrid_utils module
    • run_regrid()
  • rook.utils.response_utils module
    • populate_response()
  • rook.utils.subset_utils module
    • run_subset()
  • rook.utils.weighted_average_utils module
    • WeightedAverage_
    • calc_weighted_mean()
    • run_weighted_average()

Submodules

rook.__version__ module

rook version information.

rook.cli module

Demo WPS service for testing and debugging.

rook.cli.get_host() → tuple[str, int]

Gather host information.

Returns:

The host and port.

Return type:

tuple[str, int]

rook.cli.run_process_action(action: str | None = None)

Run an action with psutil on current process and return a status message.

Parameters:

action (str, optional) – The action to perform, by default “status”.

rook.cli.write_user_config(**kwargs) → Path

Write a custom configuration file.

Parameters:

**kwargs (dict) – Configuration parameters.

Returns:

The path to the written configuration file.

Return type:

Path

rook.exceptions module

exception rook.exceptions.WorkflowValidationError

Bases: Exception

rook.operator module

class rook.operator.AverageByDimension(output_dir)

Bases: Operator

prefix = 'average'

class rook.operator.AverageByShape(output_dir)

Bases: Operator

prefix = 'average_shape'

class rook.operator.AverageByTime(output_dir)

Bases: Operator

prefix = 'average_time'

class rook.operator.Concat(output_dir)

Bases: Operator

prefix = 'concat'

class rook.operator.Operator(output_dir)

Bases: object

call(args)

prefix = NotImplemented

class rook.operator.Regrid(output_dir)

Bases: Operator

prefix = 'regrid'

class rook.operator.Subset(output_dir)

Bases: Operator

prefix = 'subset'

class rook.operator.WeightedAverage(output_dir)

Bases: Operator

prefix = 'weighted_average'

rook.provenance module

class rook.provenance.Provenance(output_dir)

Bases: object

add_operator(operator, parameters, collection, output)

dump_json()

get_provn()

property identifier

json()

start(workflow=False)

stop()

write_json()

write_png()

rook.rook module

Main module.

rook.workflow module

class rook.workflow.BaseWorkflow(output_dir)

Bases: object

run(wfdoc)

validate(wfdoc)

class rook.workflow.Workflow(output_dir)

Bases: BaseWorkflow

validate(wfdoc)

class rook.workflow.WorkflowRunner(output_dir)

Bases: object

property provenance

run(path)

rook.workflow.build_tree(wfdoc)

rook.workflow.is_file(data)

rook.workflow.load_wfdoc(data)

rook.workflow.replace_inputs(wfdoc)

rook.wsgi module

rook.wsgi.create_app(cfgfiles: list[str] | None = None) → Service

Create PyWPS application.

Parameters:

cfgfiles (list of str, optional) – Configuration files to use.

Returns:

PyWPS application.

Return type:

pywps.app.Service.Service