`chgres_cube`

Note

The uwtools drivers are idempotent, meaning that actions they successfully complete during one invocation are not repeated in subsequent invocations. For example, an asset like a configuration file will not be recreated when the driver is run again, even if its UW YAML configuration changes. To force recreation, remove the asset(s) in question – up to and including the entire provisioned run directory – then re-run the driver, which will recreate any missing assets based on the current configuration.

The uw mode for configuring and running the chgres_cube component.

uw chgres_cube --help

usage: uw chgres_cube [-h] [--version] [--show-schema] TASK ...

Execute chgres_cube tasks

Optional arguments:
  -h, --help
      Show help and exit
  --version
      Show version info and exit
  --show-schema
      Show driver schema and exit

Positional arguments:
  TASK
    namelist_file
      The namelist file
    provisioned_rundir
      Run directory provisioned with all required content
    run
      A run
    runscript
      The runscript
    show_output
      Show the output to be created by this component
    validate
      Validate the UW driver config

All tasks take the same arguments. For example:

uw chgres_cube run --help

usage: uw chgres_cube run --cycle CYCLE --leadtime LEADTIME [-h] [--version]
                          [--config-file PATH] [--batch] [--dry-run]
                          [--graph-file PATH] [--key-path KEY[.KEY...]]
                          [--schema-file PATH] [--quiet] [--verbose]

A run

Required arguments:
  --cycle CYCLE
      The cycle in ISO8601 format (e.g. yyyy-mm-ddThh)
  --leadtime LEADTIME
      The leadtime as hours[:minutes[:seconds]]

Optional arguments:
  -h, --help
      Show help and exit
  --version
      Show version info and exit
  --config-file PATH, -c PATH
      Path to UW YAML config file (default: read from stdin)
  --batch
      Submit job to batch scheduler
  --dry-run
      Only log info, making no changes
  --graph-file PATH
      Path to Graphviz DOT output [experimental]
  --key-path KEY[.KEY...]
      Dot-separated path of keys to driver config block
  --schema-file PATH
      Path to schema file to use for validation
  --quiet, -q
      Print no logging messages
  --verbose, -v
      Print all logging messages

Examples

The examples use a configuration file named config.yaml with content similar to:

chgres_cube:
  execution:
    executable: chgres_cube
    mpiargs:
      - "--export=NONE"
    mpicmd: srun
    threads: 1
  namelist:
    update_values:
      config:
        atm_files_input_grid: atm.t{{ cycle.strftime('%H') }}z.nc
        convert_atm: true
        convert_nst: true
        convert_sfc: true
        cycle_day: !int "{{ cycle.strftime('%d') }}"
        cycle_hour: !int "{{ cycle.strftime('%H') }}"
        cycle_mon: !int "{{ cycle.strftime('%m') }}"
        data_dir_input_grid: /path/to/data/{{ cycle.strftime('%Y%M%d%H') }}
        fix_dir_target_grid: /path/to/fixdir
        grib2_file_input_grid: a.file.gb2
        mosaic_file_target_grid: /path/to/mosaic/C432.mosaic.halo4.nc
        orog_dir_target_grid: /path/to/fixdir
        orog_files_target_grid: C432.oro_data.tile7.halo4.nc
        sfc_files_input_grid: sfc.t{{cycle.strftime('%H') }}z.nc
        varmap_file: /path/to/varmap_table
        vcoord_file_target_grid: /path/to/global_hyblev.l65.txt
    validate: true
  rundir: /path/to/dir
platform:
  account: me
  scheduler: slurm

Its contents are described in depth in section chgres_cube. Each of the values in the chgres_cube YAML may contain Jinja2 variables/expressions using a cycle variable, which is a Python datetime object corresponding to the FV3 cycle being run.

Run chgres_cube on an interactive node
```
$ uw chgres_cube run --config-file config.yaml --cycle 2023-12-15T18
```
The driver creates a runscript.chgres_cube file in the directory specified by rundir: in the config and runs it, executing chgres_cube.
Run chgres_cube via a batch job
```
$ uw chgres_cube run --config-file config.yaml --cycle 2023-12-15T18 --batch
```
The driver creates a runscript.chgres_cube file in the directory specified by rundir: in the config and submits it to the batch system. Running with --batch requires a correctly configured platform: block in config.yaml, as well as appropriate settings in the execution: block under chgres_cube:.
Specifying the --dry-run flag results in the driver logging messages about actions it would have taken, without actually taking any.
```
$ uw chgres_cube run --config-file config.yaml --cycle 2023-12-15T18 --batch --dry-run
```

The --key-path option can be used to navigate from the top of the config to the driver’s configuration block. For example, specifying --key-path foo.bar with config
```
foo:
  bar:
    driver:
      # driver config block
```
is equivalent to using config
```
driver:
  # driver config block
```
without specifying --key-path.

The run task depends on the other available tasks and executes them as prerequisites. It is possible to execute any task directly, which entails execution of any of its dependencies. For example, to create a chgres_cube run directory provisioned with all the files, directories, symlinks, etc. required per the configuration file:
```
$ uw chgres_cube provisioned_rundir --config-file config.yaml --cycle 2023-12-15T18 --batch
```

Specifying the --show-schema flag, with no other options, prints the driver’s schema:

uw chgres_cube --show-schema >schema
head -n20 schema

{
  "properties": {
    "chgres_cube": {
      "additionalProperties": false,
      "properties": {
        "execution": {
          "additionalProperties": false,
          "properties": {
            "batchargs": {
              "additionalProperties": true,
              "properties": {
                "cores": {
                  "type": "integer"
                },
                "debug": {
                  "type": "boolean"
                },
                "exclusive": {
                  "type": "boolean"
                },

Use the --schema-file option to specify a custom JSON Schema file with which to validate the driver config. A custom schema could range in complexity from the simplest, most permissive schema, {}, to one based on the internal schema shown by --show-schema.

chgres_cube

Examples

`chgres_cube`