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.ROMSSimulation.pre_run#
- ROMSSimulation.pre_run(overwrite_existing_files: bool = False) None#
Perform pre-processing steps needed to run the ROMS simulation.
This method partitions any required input datasets according to the computational domain decomposition specified in the discretization settings. Each dataset is divided into smaller files so that they can be processed in parallel by ROMS during execution.
- Parameters:
(bool (overwrite_existing_files) – If True, any existing partitioned files will be overwritten
False) (default) – If True, any existing partitioned files will be overwritten
- Raises:
ValueError – If any input dataset exists but has not been partitioned correctly.
Notes
Partitioning is based on n_procs_x and n_procs_y defined in the discretization attribute.
This method must be called before run() to ensure that ROMS can correctly access its input data.