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.

ROMSForcingCorrections

class cstar.roms.input_dataset.ROMSForcingCorrections(location: str, file_hash: str | None = None, start_date: str | datetime | None = None, end_date: str | datetime | None = None, source_np_xi: int | None = None, source_np_eta: int | None = None)

Bases: ROMSInputDataset

ROMS forcing correction file, such as SW correction or restoring fields.

These are used by older ROMS configurations, and included in C-Star to support them.

This file must not be generated from a roms-tools YAML. It should point directly to a NetCDF or similar file.

Methods

ROMSForcingCorrections.get(local_dir)	Obtain and stage this ROMSInputDataset, making it locally available to C-Star.
ROMSForcingCorrections.partition(np_xi, np_eta)	Partition a netCDF dataset into tiles to run ROMS in parallel.
ROMSForcingCorrections.to_dict()	Represent this InputDataset object as a dictionary of kwargs.

Attributes

ROMSForcingCorrections.exists_locally	Check if an unmodified version of this InputDataset exists on the local filesystem.
ROMSForcingCorrections.log	Return the logger instance for this class.
ROMSForcingCorrections.path_for_roms	Returns a list of Paths corresponding to this ROMSInputDataset that can be read by ROMS.
ROMSForcingCorrections.source_partitioning
ROMSForcingCorrections.working_copy	Describes the (if any) locally available copy of this InputDataset.