4.2.4. thuner.option.grid

Classes for grid options.

pydantic model thuner.option.grid.GridOptions

Bases: BaseOptions

Class for grid options.

Fields:

• altitude (list[float] | None)

• altitude_spacing (float | None)

• cartesian_spacing (list[float] | None)

• central_latitude (float | None)

• central_longitude (float | None)

• geographic_spacing (list[float] | None)

• latitude (list[float] | None)

• longitude (list[float] | None)

• name (Literal['geographic', 'cartesian'])

• projection (str | None)

• regrid (bool)

• shape (tuple[int, int] | None)

• type (Literal['GridOptions'])

• x (list[float] | None)

• y (list[float] | None)

Validators:

• _check_altitude » all fields

• _check_shape » all fields

• _check_spacing » all fields

field altitude: list[float] | None = None

z-coordinates for the dataset.

field altitude_spacing: float | None = 500

Spacing for the altitude grid in metres.

field cartesian_spacing: list[float] | None = [2500, 2500]

Spacing for the horizontal cartesian grid [y, x] in metres.

field central_latitude: float | None = None

Central latitude for the dataset.

field central_longitude: float | None = None

Central longitude for the dataset.

field geographic_spacing: list[float] | None = [0.025, 0.025]

Spacing for the horizontal geographic grid [lat, lon] in degrees.

field latitude: list[float] | None = None

latitudes for the dataset.

field longitude: list[float] | None = None

longitudes for the dataset.

field name: Literal['geographic', 'cartesian'] = 'geographic'

Name of the grid.

field projection: str | None = None

Projection used if the dataset is cartesian.

field regrid: bool = True

Whether to attempt to regrid the dataset.

field shape: tuple[int, int] | None = None

Shape of the dataset.

field type: Literal['GridOptions'] = 'GridOptions'

field x: list[float] | None = None

x-coordinates for the dataset in meters.

field y: list[float] | None = None

y-coordinates for the dataset in meters.