rompy.swan.components.output.POINTS_FILE#

pydantic model rompy.swan.components.output.POINTS_FILE[source]#

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'

Show JSON schema
{
   "title": "POINTS_FILE",
   "description": "Isolated output locations.\n\n.. code-block:: text\n\n    POINTS 'sname' FILE 'fname'\n\nWith this optional command the user defines a set of individual output point\nlocations from text file. The file should have one point per row with x-coordinates\nand y-coordinates in the first and second columns respectively.\n\nNote\n----\nAll coordinates and distances should be given in m when Cartesian coordinates are\nused or degrees when Spherical coordinates are used (see command COORD).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.output import POINTS_FILE\n    loc = POINTS_FILE(sname=\"outpts\", fname=\"./output_locations.txt\")\n    print(loc.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "points_file",
         "description": "Model type discriminator",
         "enum": [
            "points_file",
            "POINTS_FILE"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "sname": {
         "description": "Name of the set of output locations defined by this command",
         "maxLength": 8,
         "title": "Sname",
         "type": "string"
      },
      "fname": {
         "description": "Name of the file containing the output locations",
         "maxLength": 36,
         "title": "Fname",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "sname",
      "fname"
   ]
}

Fields:
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[source]#

Command file string for this component.