uwtools.api.forecast

uwtools.api.forecast.run(model: str, cycle: datetime, config_file: Union[Path, str], batch_script: Optional[Union[Path, str]] = None, dry_run: bool = False) → bool

Run a forecast model.

If batch_script is specified, a batch script will be written that, when submitted to the appropriate scheduler, will run the forecast on batch resources. When not specified, the forecast will be run immediately on the current system, without creation of a batch script.

Parameters

• model – One of: FV3

• cycle – The cycle to run

• config_file – Path to config file for the forecast run

• batch_script – Path to a batch script to write

• dry_run – Do not run forecast, just report what would have been done

Returns

Success status of requested operation (immediate run or batch-script creation)