`fv3`

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 FV3.

uw fv3 --help

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

Execute fv3 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
    boundary_files
      Lateral boundary-condition files
    diag_table
      The diag_table file
    field_table
      The field_table file
    files_copied
      Files copied for run
    files_linked
      Files linked for run
    model_configure
      The model_configure file
    namelist_file
      The namelist file
    provisioned_rundir
      Run directory provisioned with all required content
    restart_directory
      The RESTART directory
    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 fv3 run --help

usage: uw fv3 run --cycle CYCLE [-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)

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 run 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. Its contents are described in depth in section fv3. Each of the values in the fv3 YAML may contain Jinja2 variables/expressions using a cycle variable, which is a Python datetime object corresponding to the FV3 cycle being run.

Run FV3 on an interactive node
```
$ uw fv3 run --config-file config.yaml --cycle 2024-02-11T12
```
The driver creates a runscript.fv3 file in the directory specified by rundir: in the config and runs it, executing FV3.
Run FV3 via a batch job
```
$ uw fv3 run --config-file config.yaml --cycle 2024-02-11T12 --batch
```
The driver creates a runscript.fv3 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 fv3:.
Specifying the --dry-run flag results in the driver logging messages about actions it would have taken, without actually taking any.
```
$ uw fv3 run --config-file config.yaml --cycle 2024-02-11T12 --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 an FV3 run directory provisioned with all the files, directories, symlinks, etc. required per the configuration file:
```
$ uw fv3 provisioned_rundir --config-file config.yaml --cycle 2024-02-11T12 --batch
```

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

uw fv3 --show-schema >schema
head -n20 schema

{
  "properties": {
    "fv3": {
      "additionalProperties": false,
      "allOf": [
        {
          "if": {
            "properties": {
              "domain": {
                "const": "regional"
              }
            }
          },
          "then": {
            "required": [
              "lateral_boundary_conditions"
            ]
          }
        }
      ],

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.

fv3

Examples

`fv3`