`orog`

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 UFS Utils preprocessing component orog.

uw orog --help

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

Execute orog 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
    files_linked
      Files linked for run
    grid_file
      The input grid file
    input_config_file
      The input config 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 orog run --help

usage: uw orog run [-h] [--version] [--config-file PATH] [--batch] [--dry-run]
                   [--graph-file PATH] [--key-path KEY[.KEY...]]
                   [--schema-file PATH] [--quiet] [--verbose]

A run

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 with contents similar to:

orog:
  execution:
    batchargs:
      cores: 1
      walltime: 00:05:00
    executable: /path/to/orog
  files_to_link:
    fort.15: /path/to/fix/thirty.second.antarctic.new.bin
    landcover30.fixed: /path/to/fix/landcover30.fixed
    fort.235: /path/to/fix/gmted2010.30sec.int
  grid_file: /path/to/netcdf/grid/file
  rundir: /path/to/run/dir
platform:
  account: me
  scheduler: slurm

Its contents are described in section orog.

Run orog on an interactive node
```
$ uw orog run --config-file config.yaml
```
The driver creates a runscript.orog file in the directory specified by rundir: in the config and runs it, executing orog.
Run orog via a batch job
```
$ uw orog run --config-file config.yaml --batch
```
The driver creates a runscript.orog 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 orog:.
Specifying the --dry-run flag results in the driver logging messages about actions it would have taken, without actually taking any.
```
$ uw orog run --config-file config.yaml --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.

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

uw orog --show-schema >schema
head -n20 schema

{
  "properties": {
    "orog": {
      "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.

orog

Examples

`orog`