Processes

Subset

class rook.processes.wps_subset.Subset[source]

subset Subset (v1.0)

Run subsetting on climate model data. Calls daops operators.

Parameters:

  • collection (string) – A dataset identifier or list of comma separated identifiersExample: c3s-cmip5.output1.ICHEC.EC-EARTH.historical.day.atmos.day.r1i1p1.tas.latest

  • time (string, optional) – The time interval (start/end) to subset over separated by ‘/’ or a list of time points separated by ‘,’. The format is according to the ISO-8601 standard. Example: 1860-01-01/1900-12-30 or 1860-01-01, 1870-01-01, 1880-01-01

  • time_components (string, optional) – Optional time components to describe parts of the time period (e.g. year, month and day). Example: month:01,02,03 or year:1970,1980|month:01,02,03

  • area (string, optional) – The area to subset over as 4 comma separated values.Example: 0.,49.,10.,65

  • level (string, optional) – The level range to subset over separated by a / or a list of level values separated by ‘,’.Example: 1000/2000 or 1000, 2000, 3000

  • pre_checked (boolean) – Use checked data only.

  • apply_fixes (boolean) – Apply fixes to datasets.

  • original_files (boolean) – Return original files only.

Returns:

  • output (application/metalink+xml; version=4.0) – Metalink v4 document with references to NetCDF files.

  • prov (application/json) – Provenance document using W3C standard.

  • prov_plot (image/png) – Provenance document as diagram.

References

Average

class rook.processes.wps_average_dim.AverageByDimension[source]

average Average by Dimensions (v1.0)

Run averaging by dimensions on climate model data.

Parameters:

  • collection (string) – A dataset identifier or list of comma separated identifiers. Example: c3s-cmip5.output1.ICHEC.EC-EARTH.historical.day.atmos.day.r1i1p1.tas.latest

  • dims ({'time', 'level', 'latitude', 'longitude', 'realization'}) – Dimensions used for aggregation. Example: level

  • pre_checked (boolean) – Use checked data only.

  • apply_fixes (boolean) – Apply fixes to datasets.

Returns:

  • output (application/metalink+xml; version=4.0) – Metalink v4 document with references to NetCDF files.

  • prov (application/json) – Provenance document using W3C standard.

  • prov_plot (image/png) – Provenance document as diagram.

References

class rook.processes.wps_average_shape.AverageByShape[source]

average_shape Average over polygonal shape (v1.0)

Run averaging over a specified shape on climate model data.

Parameters:

  • collection (string) – A dataset identifier or list of comma separated identifiers. Example: c3s-cmip5.output1.ICHEC.EC-EARTH.historical.day.atmos.day.r1i1p1.tas.latest

  • shape (application/gml+xml, application/geo+json, application/x-zipped-shp, application/json, application/zip) – An ESRI Shapefile, GML, GeoPackage, JSON or GeoJSON file. The ESRI Shapefile must be zipped and contain the .shp, .shx, and .dbf.

  • pre_checked (boolean) – Use checked data only.

  • apply_fixes (boolean) – Apply fixes to datasets.

Returns:

  • output (application/metalink+xml; version=4.0) – Metalink v4 document with references to NetCDF files.

  • prov (application/json) – Provenance document using W3C standard.

  • prov_plot (image/png) – Provenance document as diagram.

References

class rook.processes.wps_average_time.AverageByTime[source]

average_time Average by Time (v1.0)

Run averaging by time on climate model data.

Parameters:

  • collection (string) – A dataset identifier or list of comma separated identifiers. Example: c3s-cmip5.output1.ICHEC.EC-EARTH.historical.day.atmos.day.r1i1p1.tas.latest

  • freq ({'year', 'month', 'day'}) – Aggregation time frequency. Example: year

  • pre_checked (boolean) – Use checked data only.

  • apply_fixes (boolean) – Apply fixes to datasets.

Returns:

  • output (application/metalink+xml; version=4.0) – Metalink v4 document with references to NetCDF files.

  • prov (application/json) – Provenance document using W3C standard.

  • prov_plot (image/png) – Provenance document as diagram.

References

class rook.processes.wps_average_weighted.WeightedAverage[source]

weighted_average Weighted Average (v1.0)

Run weighted averaging on climate model data.

Parameters:

collection (string) – A dataset identifier or list of comma separated identifiers. Example: c3s-cmip5.output1.ICHEC.EC-EARTH.historical.day.atmos.day.r1i1p1.tas.latest

Returns:

  • output (application/metalink+xml; version=4.0) – Metalink v4 document with references to NetCDF files.

  • prov (application/json) – Provenance document using W3C standard.

  • prov_plot (image/png) – Provenance document as diagram.

References

Orchestrate

class rook.processes.wps_orchestrate.Orchestrate[source]

orchestrate Orchestrate (v1.0)

Run a workflow with combined operations. A workflow can be build using the rooki client.

Parameters:

workflow (application/json) – Workflow

Returns:

  • output (application/metalink+xml; version=4.0) – Metalink v4 document with references to NetCDF files.

  • prov (application/json) – Provenance document using W3C standard.

  • prov_plot (image/png) – Provenance document as diagram.

References