dummy / std

Yaml arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Optional arguments

filelon: (optional)

Path to a text file defining the list of longitudes

accepted type: <class ‘str’>

filelat: (optional)

Path to a text file defining the list of latitudes

accepted type: <class ‘str’>

projection: (optional): xy

Type of projection to use for computations with this domain

accepted values:

  • gps: standard GPS coordinates

  • xy: coordinates as meters from a reference point

nlon: (optional)

Number of grid cells in the zonal direction

accepted type: <class ‘int’>

nlat: (optional)

Number of grid cells in the meridional direction

accepted type: <class ‘int’>

xmin: (optional)

Coordinate of the left border of the domain

accepted type: <class ‘float’>

xmax: (optional)

Coordinate of the right border of the domain

accepted type: <class ‘float’>

ymin: (optional)

Coordinate of the bottom border of the domain

accepted type: <class ‘float’>

ymax: (optional)

Coordinate of the top border of the domain

accepted type: <class ‘float’>

Yaml template

Please find below a template for a Yaml configuration:

 1domain:
 2  plugin:
 3    name: dummy
 4    version: std
 5    type: domain
 6
 7
 8  # Optional arguments
 9  filelon: XXXXX
10  filelat: XXXXX
11  projection: XXXXX
12  nlon: XXXXX
13  nlat: XXXXX
14  xmin: XXXXX
15  xmax: XXXXX
16  ymin: XXXXX
17  ymax: XXXXX