Skip to content

Commit d4611a4

Browse files
authored
Merge pull request #44 from navidcy/patch-1
Add missing backticks
2 parents c9127b6 + 2ffc041 commit d4611a4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/io.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ and for concatenating the files together:
3434
{'dim': 'ocean_time', 'data_vars': 'minimal', 'coords': 'minimal'}
3535

3636

37-
## Suggested Workflow for `xroms:
37+
## Suggested Workflow for `xroms`:
3838

3939
1. Read in model output using the appropriate `xarray` function.
4040
2. Supplement your Dataset and calculate an `xgcm` grid object with:
4141

4242
ds, xgrid = xroms.roms_dataset(ds)
4343

44-
The function adds `z` coordinates and other useful metrics to the `Dataset`, including the z coordinates on each horizontal grid (e.g., z_rho_u), and the z coordinates relative to mean sea level (e.g., z_rho0). It also sets up an xgcm grid object for the Dataset, which is stored necessary for many `xroms` functions, and can be stored and accessible in the accessor (`ds.xroms.xgrid`).
44+
The function adds `z` coordinates and other useful metrics to the `Dataset`, including the z coordinates on each horizontal grid (e.g., `z_rho_u`), and the z coordinates relative to mean sea level (e.g., `z_rho0`). It also sets up an xgcm grid object for the Dataset, which is stored necessary for many `xroms` functions, and can be stored and accessible in the accessor (`ds.xroms.xgrid`).
4545

4646
There are optional flags for `xroms.roms_dataset()` for what all metrics to lazily calculate since it can be time-consuming despite being lazily loaded and calculated; see the {doc}`API docs <api>` for details.
4747

0 commit comments

Comments
 (0)