Merge pull request #34 from COSIMA/iss33

Update README.md re. vgrid
COSIMA · Sep 16, 2024 · aea17bf · aea17bf
2 parents fcc9c69 + 7c0d158
commit aea17bf
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ Code and tools to edit and manipulate ocean model grids and topographies.
 
 Below is a list of included tools and short documentation for each.
 
+**Note:** in all cases `<vgrid>` is assumed to be a MOM5 vertical grid file (with $2n+1$ values for an $n$-level model). Using a MOM6 `<vgrid>` file (with $n+1$ values) will produce incorrect results.
 
 ## topogtools (Russ' Fortran tools)