uwtools.api.cdeps

API access to the uwtools cdeps driver.

class uwtools.api.cdeps.CDEPS(cycle, config=None, key_path=None, schema_file=None, controller=None)

A driver for the CDEPS data models.

Parameters:

  • cycle (datetime) – The cycle.

  • config (dict | str | YAMLConfig | Path | None) – Path to config file (read stdin if missing or None).

  • key_path (list[YAMLKey] | None) – Keys of keys to driver config block.

  • schema_file (Path | None) – Path to schema file to use to validate an external driver.

  • controller (list[YAMLKey] | None) – Key(s) leading to block in config controlling run-time values.

atm()

The data atmosphere configuration with all required content.

atm_nml()

The data atmosphere Fortran namelist file (datm_in).

atm_stream()

The data atmosphere stream config file (datm.streams).

property config: dict

A copy of the driver-specific config.

property config_full: dict

A copy of the original input config, dereferenced.

static create_user_updated_config(config_class, config_values, path, schema=None)

Create a config from a base file, user-provided values, or a combination of the two.

Parameters:

  • config_class (type[Config]) – The Config subclass matching the config type.

  • config_values (dict) – The configuration object to update base values with.

  • path (Path) – Path to dump file to.

  • schema (dict | None) – Schema to validate final config against.

Return type:

None

property cycle

The cycle.

classmethod driver_name()

The name of this driver.

Return type:

str

namelist_schema(config_keys=None, schema_keys=None)

Return the (sub)schema for validating the driver’s namelist content.

Parameters:

  • config_keys (list[YAMLKey] | None) – Keys leading to the namelist block in the driver config.

  • schema_keys (list[str] | None) – Keys leading to the namelist-validating (sub)schema.

Return type:

dict

ocn()

The data ocean configuration with all required content.

ocn_nml()

The data ocean Fortran namelist file (docn_in).

ocn_stream()

The data ocean stream config file (docn.streams).

property rundir: Path

The path to the component’s run directory.

classmethod schema()

Return the driver’s internal schema.

Return type:

dict

taskname(suffix=None)

Return a common tag for task-related log messages.

Parameters:

suffix (str | None) – Log-string suffix.

Return type:

str

validate()

Validate the UW driver config.

uwtools.api.cdeps.execute(task, cycle, config=None, batch=False, dry_run=False, graph_file=None, key_path=None, schema_file=None, stdin_ok=False)

Execute a task.

If batch is specified, a runscript will be written and submitted to the batch system. Otherwise, the executable will be run directly on the current system.

Parameters:

  • task (str) – The task to execute.

  • config (Path | str | None) – Path to config file (read stdin if missing or None).

  • cycle (dt.datetime) – The cycle.

  • batch (bool) – Submit run to the batch system?

  • dry_run (bool) – Do not run the executable, just report what would have been done.

  • graph_file (Path | str | None) – Write Graphviz DOT output here.

  • key_path (list[YAMLKey] | None) – Path of keys to config block to use.

  • schema_file (Path | str | None) – The JSON Schema file to use for validation.

  • stdin_ok (bool) – OK to read from stdin?

Returns:

True if task completes without raising an exception.

Return type:

bool

uwtools.api.cdeps.schema()

Return the driver’s schema.

Return type:

dict

uwtools.api.cdeps.tasks()

Return a mapping from task names to their one-line descriptions.

Return type:

dict[str, str]