rompy.swan.components.output.POINTS_FILE

pydantic model rompy.swan.components.output.POINTS_FILE

Isolated output locations.

POINTS 'sname' FILE 'fname'

With this optional command the user defines a set of individual output point locations from text file. The file should have one point per row with x-coordinates and y-coordinates in the first and second columns respectively.

Note

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

Examples

In [1]: from rompy.swan.components.output import POINTS_FILE

In [2]: loc = POINTS_FILE(sname="outpts", fname="./output_locations.txt")

In [3]: print(loc.render())
POINTS sname='outpts' fname='./output_locations.txt'

Fields:

• fname (str)

• model_type (Literal['points_file', 'POINTS_FILE'])

Validators:

field fname: str [Required]

Name of the file containing the output locations

Constraints:

• max_length = 36

field model_type: Literal['points_file', 'POINTS_FILE'] = 'points_file'

Model type discriminator

cmd() → str

Command file string for this component.