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: str
filelat: (optional)
Path to a text file defining the list of latitudes
accepted type: 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: int
nlat: (optional)
Number of grid cells in the meridional direction
accepted type: int
xmin: (optional)
Coordinate of the left border of the domain
accepted type: float
xmax: (optional)
Coordinate of the right border of the domain
accepted type: float
ymin: (optional)
Coordinate of the bottom border of the domain
accepted type: float
ymax: (optional)
Coordinate of the top border of the domain
accepted type: 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 # Optional arguments
8 filelon: XXXXX # str
9 filelat: XXXXX # str
10 projection: XXXXX # gps|xy
11 nlon: XXXXX # int
12 nlat: XXXXX # int
13 xmin: XXXXX # float
14 xmax: XXXXX # float
15 ymin: XXXXX # float
16 ymax: XXXXX # float
