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.ROMSInitialConditions.check_nc_pio_compatible

ROMSInitialConditions.check_nc_pio_compatible() → list[str]

Check this dataset’s files for properties ROMS with ParallelIO cannot read.

ROMS with use_pio reads inputs through PnetCDF, which requires classic-format files (CDF-1/2/5, e.g. netCDF-4/HDF5 files are unreadable). Additionally, PIO only supports 64-bit and unsigned variable types when built against a parallel-enabled netCDF-C library, which is not available in all environments (e.g. conda), so these types are also rejected.

Every file in path_for_roms_unpartitioned is checked.

Returns:

list of str – A description of each problem found; empty if all files are compatible.