Processes

Subset

class rook.processes.wps_subset.Subset

subset Subset (v1.0)

Run subsetting on climate model data.

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) – Deprecated compatibility parameter. Rook no longer uses pre-checked data selection.

• apply_fixes (boolean) – Deprecated compatibility parameter. Rook now applies required dataset fixes automatically.

• 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

• CLISOPS

Average by Time

class rook.processes.wps_average_time.AverageByTime

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) – Deprecated compatibility parameter. Rook no longer uses pre-checked data selection.

• apply_fixes (boolean) – Deprecated compatibility parameter. Rook now applies required dataset fixes automatically.

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

• CLISOPS

Average by Dimension

class rook.processes.wps_average_dim.AverageByDimension

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) – Deprecated compatibility parameter. Rook no longer uses pre-checked data selection.

• apply_fixes (boolean) – Deprecated compatibility parameter. Rook now applies required dataset fixes automatically.

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

• CLISOPS

Average by Shape

class rook.processes.wps_average_shape.AverageByShape

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) – Deprecated compatibility parameter. Rook no longer uses pre-checked data selection.

• apply_fixes (boolean) – Deprecated compatibility parameter. Rook now applies required dataset fixes automatically.

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

• CLISOPS

Weighted Average

class rook.processes.wps_average_weighted.WeightedAverage

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

• CLISOPS

Concat

class rook.processes.wps_concat.Concat

concat Concat (v1.0)

Run concat on climate model data.

Parameters:

• collection (string) – A list of dataset identifiers. Example: c3s-cmip6-decadal.DCPP.MPI-M.MPI-ESM1-2-HR.dcppA-hindcast.s1960-r10i1p1f1.Amon.tas.gn.v20200908

• 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

• dims ({'realization'}) – Dimensions used for aggregation. Example: realization

• apply_average (boolean) – Apply Average over dims.

• pre_checked (boolean) – Deprecated compatibility parameter. Rook no longer uses pre-checked data selection.

• apply_fixes (boolean) – Deprecated compatibility parameter. Rook now applies required dataset fixes automatically.

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

• CLISOPS

Regrid

class rook.processes.wps_regrid.Regrid

regrid Regrid (v1.0)

Run regridding operator on climate model data using clisops (xarray).

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

• method ({'nearest_s2d', 'bilinear', 'conservative', 'patch'}) – Please specify regridding method like consevative or bilinear. Default: nearest_s2d

• grid ({'auto', '0pt25deg', '0pt25deg_era5', '0pt5deg_lsm', '0pt625x0pt5deg', '0pt75deg', '1deg', '1pt25deg', '2pt5deg', 'custom'}) – Select target grid resolution for regridding. Choose a predefined grid or select ‘custom’ to provide your own.

• custom_grid (string, optional) – Only used if grid=’custom’. Provide space-separated numbers defining the target grid. Allowed lengths: 1 (d), 2 (d_lon d_lat), 3 (lonlat_0 lonlat_1 d_lonlat), 6 (lon_0 lon_1 d_lon lat_0 lat_1 d_lat). Examples: ‘0.5’ (uniform 0.5° grid), ‘0.5 0.25’ (0.5° lon x 0.25° lat), ‘-90 90 0.25’ (lat-only range), ‘-10 30 0.25 35 70 0.25’ (full bounding box).

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

• CLISOPS

Orchestrate

class rook.processes.wps_orchestrate.Orchestrate

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

• Rooki

Usage

class rook.processes.wps_usage.Usage

usage Usage (v0.4)

Run usage collector.

Parameters:

time (string, optional) – The time period for usage collection separated by /Example: 2024-06-01/2024-06-30

Returns:

• wpsusage (text/csv) – OGC:WPS metrics collected from pywps database.

• downloads (text/csv) – Downloads collected from nginx log file.

References

• ROOK

Dashboard

class rook.processes.wps_dashboard.DashboardProcess

dashboard Dashboard (v0.3)

Run dashboard.

Parameters:

• site ({'local', 'ipsl', 'dkrz', 'all'}) – The name of the compute siteExample: cds

• time (string, optional) – The time period for usage collection separated by /Example: 2024-06-01/2024-06-30

Returns:

dashboard – Dashboard of OGC:WPS metrics.

Return type:

text/plain

References

• ROOK