Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
aekiss committed Oct 21, 2024
1 parent a2dc32b commit f2dfe61
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,14 @@ Options
### deseas

```
usage: topogtools deseas --input <input_file> --output <output_file>
usage: topogtools deseas --input <input_file> --output <output_file> [--grid_type <type>]
```

Remove enclosed seas from <input_file> and writes the result to <output_file>.

Options
* `--grid_type <type>` Arakawa type of horizontal grid ('B' or 'C'; default is 'B')

### min_max_depth

```
Expand All @@ -70,25 +73,30 @@ Options

```
usage: topogtools fill_fraction --input <input_file> --output <output_file>
--fraction <frac>
--fraction <frac> [--grid_type <type>]
```

Cells with a fraction of sea area smaller than <frac> will have their depth set
to zero. Can produce non-advective cells and/or new seas.

Options
* `--grid_type <type>` Arakawa type of horizontal grid ('B' or 'C'; default is 'B')

### check_nonadvective

```
usage: topogtools check_nonadvective --input <input_file>
[--vgrid <vgrid> --vgrid_type <type>
--potholes --coastal-cells]
[--grid_type <type>
--vgrid <vgrid> --vgrid_type <type>
--potholes --coastal-cells]
```

Check for non-advective cells. There are two types of checks available: potholes
and non-advective coastal cells. Checking for non-advective coastal cells should
only be needed when using a B-grid.

Options
* `--grid_type <type>` Arakawa type of horizontal grid ('B' or 'C'; default is 'B')
* `--vgrid <vgrid>` vertical grid (default 'ocean_vgrid.nc')
* `--vgrid_type <type>` can be mom5 or mom6 (default 'mom5')
* `--potholes` check for potholes
Expand All @@ -98,7 +106,8 @@ Options

```
usage: topogtools fix_nonadvective --input <input_file> --output <output_file>
[--vgrid <vgrid> --vgrid_type <type>
[--grid_type <type>
--vgrid <vgrid> --vgrid_type <type>
--potholes --coastal-cells]
```

Expand All @@ -107,6 +116,7 @@ non-advective coastal cells. Fixes to non-advective coastal cells should only be
needed when using a B-grid.

Options
* `--grid_type <type>` Arakawa type of horizontal grid ('B' or 'C'; default is 'B')
* `--vgrid <vgrid>` vertical grid (default 'ocean_vgrid.nc')
* `--vgrid_type <type>` can be mom5 or mom6 (default 'mom5')
* `--potholes` fix potholes
Expand Down

0 comments on commit f2dfe61

Please sign in to comment.