dummy/std dummy/std

dummy/std dummy/std#

Description#

Dummy domain plugin.

Provides a minimal Cartesian domain for unit tests and simple toy models. Coordinates are in metres from a reference point (projection = 'xy'), not GPS degrees.

Two initialisation paths:

  • From files — read_grid loads 1-D arrays from text files filelon / filelat.

  • From parameters — when files are absent, create_domain builds a uniform Cartesian grid from xmin, xmax, ymin, ymax, nlon, nlat and saves the coordinates to {workdir}/domain/.

No vertical coordinate is defined (single surface level).

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 : str, optional

Path to a text file defining the list of longitudes

filelat : str, optional

Path to a text file defining the list of latitudes

projection : “gps” or “xy”, optional, default “xy”

Type of projection to use for computations with this domain

  • “gps”: standard GPS coordinates

  • “xy”: coordinates as meters from a reference point

nlon : int, optional

Number of grid cells in the zonal direction

nlat : int, optional

Number of grid cells in the meridional direction

xmin : float, optional

Coordinate of the left border of the domain

xmax : float, optional

Coordinate of the right border of the domain

ymin : float, optional

Coordinate of the bottom border of the domain

ymax : float, optional

Coordinate of the top border of the domain

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

See also

API reference (functions & code)