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.

ROMSRiverForcing

class cstar.roms.input_dataset.ROMSRiverForcing(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, linker: DatasetLinker | None = None)

Bases: ROMSInputDataset

An implementation of the ROMSInputDataset class for river forcing files.

Methods

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

Attributes

ROMSRiverForcing.end_date	The maximum date in the dataset.
ROMSRiverForcing.exists_locally	Check if an unmodified version of this InputDataset exists on the local filesystem.
ROMSRiverForcing.log	Return the logger instance for this class.
ROMSRiverForcing.partitionable	Set to False if the input dataset should not be partitioned.
ROMSRiverForcing.path_for_roms	Returns a list of Paths corresponding to this ROMSInputDataset that can be read by ROMS.
ROMSRiverForcing.source_partitioning
ROMSRiverForcing.start_date	The minimum date in the dataset.
ROMSRiverForcing.working_copy	Describes the (if any) locally available copy of this InputDataset.
ROMSRiverForcing.source	The location of and classifies the source data