OPH_CREATECONTAINER

Description

Type

Data Process.

Behaviour

It creates an empty container.

Parameters

  • container: name of the output container. It must be unique among folders and visible containers within the same parent folder.
  • cwd: absolute path corresponding to the current working directory, used to select the folder where the container will be created.
  • dim: names of the dimensions allowed. Multiple-value field: list of dimensions separated by “|” can be provided.
  • dim_type: types of the dimensions. Multiple-value field: list of types separated by “|” can be provided. Default value is “double” for all the dimensions.
  • hierarchy: concept hierarchy name of the dimensions. Default value is “oph_base”. Multiple-value field: list of concept hierarchies separated by “|” can be provided.
  • base_time: in case of time hierarchy, it indicates the base time of the dimension. Default value is 1900-01-01.
  • units: in case of time hierarchy, it indicates the units of the dimension. Possible values are: s, m, h, 3, 6, d.
  • calendar: in case of time hierarchy, it indicates the calendar type. Possible values are:
    • standard (default)
    • gregorian
    • proleptic_gregorian
    • julian
    • 360_day
    • no_leap
    • all_leap
    • user_defined
  • month_lengths: in case of time dimension and user-defined calendar, it indicates the sizes of each month in days. There must be 12 positive integers separated by commas. Default is ‘31,28,31,30,31,30,31,31,30,31,30,31’.
  • leap_year: in case of time dimension and user-defined calendar, it indicates the first leap year. By default it is set to 0.
  • leap_month: in case of time dimension and user-defined calendar, it indicates the leap month. By default it is set to 2 (i.e. February).
  • vocabulary: optional argument used to indicate a vocabulary (name of set of keys) to be used to associate metadata to the container.
  • compressed: if “yes”, new data will be compressed. With “no” (default), data will be inserted without compression.
  • description: additional description to be associated with the output container.

System parameters

  • exec_mode: operator execution mode. Possible values are async (default) for asynchronous mode, sync for synchronous mode with json-compliant output.
  • ncores: number of parallel processes to be used (min. 1). This operator is not parallel, so the only possible value is 1.
  • sessionid: session identifier used server-side to manage sessions and jobs. Usually, users don’t need to use/modify it, except when it is necessary to create a new session or switch to another one.
  • objkey_filter: filter on the output of the operator written to file (default=all => no filter, none => no output, createcontainer => shows operator’s output PID as text).

Examples

Create a new container ‘container1’ with dimensions lat, lon and time into folder ‘/’:

[OPH_TERM] >>  oph_createcontainer container=container1;cwd=/;dim=lat|lon|time;dim_type=double|double|double;hierarchy=oph_base|oph_base|oph_time;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
exec_mode “string” “no” “async|sync” “async”  
container “string” “yes”      
cwd “string” “yes”      
dim “string” “yes”      
dim_type “string” “no” “double|float|int|long|short|byte” “double”  
hierarchy “string” “no”   “oph_base”  
base_time “string” “no”   “1900-01-01 00:00:00”  
units “string” “no” “s|m|h|3|6|d” “d”  
calendar “string” “no” “standard|gregorian|proleptic_gregorian|julian|360_day|no_leap|all_leap|use r_defined” “standard”  
month_lengths “string” “no”   “31,28,31,30,31,30,31,31, 30,31,30,31”  
leap_year “int” “no”   “0” “0” /
leap_month “int” “no”   “2” “1” / “12”
vocabulary “string” “no”   “CF”  
compressed “string” “no” “yes|no” “no”  
description “string” “no”   “-“  
objkey_filter “string” “no” “all|none|createcontainer “ “all”