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.ROMSInputDataset.get

ROMSInputDataset.get(local_dir: str | Path) → None

Obtain and stage this ROMSInputDataset, making it locally available to C-Star.

This method updates the ROMSInputDataset.working_copy attribute.

Parameters:

local_dir (str or Path):

Directory to save the dataset files.