rompy.swan.subcomponents.base.XY

pydantic model rompy.swan.subcomponents.base.XY

Points in problem coordinates.

< [x] [y] >

Note

Coordinates should be given in m when Cartesian coordinates are used or degrees when Spherical coordinates are used (see command COORD).

Examples

In [238]: from rompy.swan.subcomponents.base import XY

In [239]: points = XY(
   .....:     x=[172, 172, 172, 172.5, 173],
   .....:     y=[-41, -40.5, -40, -40, -40],
   .....:     fmt="0.2f",
   .....: )
   .....: 

In [240]: print(points.render())

172.00 -41.00
172.00 -40.50
172.00 -40.00
172.50 -40.00
173.00 -40.00

Fields:

• fmt (str)

• model_type (Literal['xy', 'XY'])

• x (list[float])

• y (list[float])

Validators:

• validate_size » all fields

field fmt: str = '0.8f'

The format to render floats values

Validated by:

• validate_size

field model_type: Literal['xy', 'XY'] = 'xy'

Model type discriminator

Validated by:

• validate_size

field x: list[float] [Required]

Problem x-coordinate values

Validated by:

• validate_size

field y: list[float] [Required]

Problem y-coordinate values

Validated by:

• validate_size

cmd() → str

validator validate_size  »  all fields

property size