Skip to content

Commit

Permalink
Add Viz step to cosine_bell docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Apr 16, 2023
1 parent 9df4317 commit bccd5e7
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/developers_guide/ocean/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@
viz.VizMap
viz.VizMap.run
viz.Viz
viz.Viz.run
```

## Ocean Framework
Expand Down
25 changes: 25 additions & 0 deletions docs/developers_guide/ocean/test_groups/global_convergence.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,28 @@ dlat = 0.5
# remapping method ('bilinear', 'neareststod', 'conserve')
remap_method = conserve
```

The class {py:class}`polaris.ocean.tests.global_convergence.cosine_bell.viz.Viz`
is a step for plotting the initial and final states of the advection test for
each resolution, mapped to the common lat-lon grid. The colormap is controlled
by these options:

```cfg
# options for visualization for the cosine bell convergence test case
[cosine_bell_viz]
# colormap options
# colormap
colormap_name = viridis
# the type of norm used in the colormap
norm_type = linear
# A dictionary with keywords for the norm
norm_args = {'vmin': 0., 'vmax': 1.}
# We could provide colorbar tick marks but we'll leave the defaults
# colorbar_ticks = np.linspace(0., 1., 9)
```

See {ref}`dev-visualization-global` for more details.
13 changes: 13 additions & 0 deletions docs/users_guide/ocean/test_groups/global_convergence.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,19 @@ dlat = 0.5
# remapping method ('bilinear', 'neareststod', 'conserve')
remap_method = conserve
# colormap options
# colormap
colormap_name = viridis
# the type of norm used in the colormap
norm_type = linear
# A dictionary with keywords for the norm
norm_args = {'vmin': 0., 'vmax': 1.}
# We could provide colorbar tick marks but we'll leave the defaults
# colorbar_ticks = np.linspace(0., 1., 9)
```

The config options in `[vertical_grid]` define the vertical grid, as described
Expand Down

0 comments on commit bccd5e7

Please sign in to comment.