rompy.core.grid.RegularGrid

pydantic model rompy.core.grid.RegularGrid

Regular grid in geographic space.

This object provides an abstract representation of a regular grid in some geographic space.

Fields:

• dx (float | None)

• dy (float | None)

• grid_type (Literal['regular'])

• nx (int | None)

• ny (int | None)

• rot (float | None)

• x0 (float | None)

• y0 (float | None)

Validators:

• generate » all fields

field dx: float | None = None

Spacing between grid points in the x direction

Validated by:

• generate

field dy: float | None = None

Spacing between grid points in the y direction

Validated by:

• generate

field grid_type: Literal['regular'] = 'regular'

Type of grid, must be ‘regular’

Validated by:

• generate

field nx: int | None = None

Number of grid points in the x direction

Validated by:

• generate

field ny: int | None = None

Number of grid points in the y direction

Validated by:

• generate

field rot: float | None = 0.0

Rotation angle of the grid in degrees

Validated by:

• generate

field x0: float | None = None

X coordinate of the grid origin

Validated by:

• generate

field y0: float | None = None

Y coordinate of the grid origin

Validated by:

• generate

validator generate  »  all fields

Generate the grid from the provided parameters.

property x: ndarray

property xlen

property y: ndarray

property ylen