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.runtime_settings.ROMSRuntimeSettings.from_file

classmethod ROMSRuntimeSettings.from_file(filepath: str | Path) → ROMSRuntimeSettings

Read ROMS runtime settings from a .in file.

ROMS runtime settings are specified via a .in file with sections corresponding to different sets of parameters (e.g. time_stepping, bottom_drag). This method first parses the file, creating a dict[str,list[str]] where the keys are the section names and the values are a list of lines in that section. It then translates that dictionary into a ROMSRuntimeSettings instance with properly formatted attributes.

Parameters:

str) (- filepath (Path or) – The path to the .in file

See also

-

ROMS-compatible .in file