pyfvcom2.grid_builder module

pyfvcom2.grid_builder.build_fvcom_grid(fvcom_mesh_filename: str, fvcom_obc_filename: str, sigma_filename: str, coordinate_system: str, epsg_code: int | None = None) → Grid

Build a Grid object from FVCOM mesh and sigma files.

Parameters:

  • fvcom_mesh_filename (str) – Path to the FVCOM mesh file.

  • fvcom_obc_filename (str) – Path to the FVCOM OBC file.

  • sigma_filename (str) – Path to the sigma coordinate file.

  • coordinate_system (str) – Coordinate system for the grid (“cartesian” or “geographic”).

  • epsg_code (Optional[int]) – EPSG code for the grid (if applicable).

Returns:

The constructed Grid object.

Return type:

Grid