cstar.roms.input_dataset.ROMSTidalForcing.partition

Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

cstar.roms.input_dataset.ROMSTidalForcing.partition#

ROMSTidalForcing.partition(np_xi: int, np_eta: int, overwrite_existing_files: bool = False) → None#

Partition a netCDF dataset into tiles to run ROMS in parallel.

Takes a local InputDataset and parallelisation parameters and uses roms-tools’ partition_netcdf method to create multiple, smaller netCDF files, each of which corresponds to a processor used by ROMS.

Parameters:#

np_xi (int):

The number of tiles in the x direction

np_eta (int):

The number of tiles in the y direction

overwrite_existing_files (bool, optional):

If True and this ROMSInputDataset has already been partitioned, the existing files will be overwritten

Notes:#

  • This method will only work on ROMSInputDataset instances corresponding

    to locally available files, i.e. ROMSInputDataset.get() has been called.

  • This method sets the ROMSInputDataset.partitioning attribute