Skip to content

Commit accf5df

Browse files
committed
Update docs
1 parent b8cd032 commit accf5df

File tree

6 files changed

+23
-0
lines changed

6 files changed

+23
-0
lines changed

docs/developers_guide/framework/visualization.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,13 @@ colormap).
154154

155155
The `colorbar_limits` are the lower and upper bound of the colorbar range.
156156

157+
There are also two optional config options used to set the colors on either end of the colormap:
157158

159+
```cfg
160+
# [optional] colormap set_under and set_over options
161+
under_color = k
162+
over_color = orange
163+
```
158164
### plotting from lat/lon grids
159165

160166
You can use {py:func}`polaris.viz.plot_global_lat_lon_field()` to plot a field

docs/developers_guide/ocean/tasks/correlated_tracers_2d.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ each resolution. The colormap is controlled by these options:
7777
# colormap
7878
colormap_name = viridis
7979
80+
# [optional] colormap set_under and set_over options
81+
under_color = k
82+
over_color = orange
83+
8084
# the type of norm used in the colormap
8185
norm_type = linear
8286

docs/developers_guide/ocean/tasks/divergent_2d.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ each resolution. The colormap is controlled by these options:
7171
# colormap
7272
colormap_name = viridis
7373
74+
# [optional] colormap set_under and set_over options
75+
under_color = k
76+
over_color = orange
77+
7478
# the type of norm used in the colormap
7579
norm_type = linear
7680

docs/developers_guide/ocean/tasks/nondivergent_2d.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ each resolution. The colormap is controlled by these options:
7777
# colormap
7878
colormap_name = viridis
7979
80+
# [optional] colormap set_under and set_over options
81+
under_color = k
82+
over_color = orange
83+
8084
# the type of norm used in the colormap
8185
norm_type = linear
8286

docs/developers_guide/ocean/tasks/rotation_2d.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ each resolution. The colormap is controlled by these options:
7171
# colormap
7272
colormap_name = viridis
7373
74+
# [optional] colormap set_under and set_over options
75+
under_color = k
76+
over_color = orange
77+
7478
# the type of norm used in the colormap
7579
norm_type = linear
7680

polaris/ocean/tasks/sphere_transport/sphere_transport.cfg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ slotted_cylinders_amplitude = 1.0
8484
# colormap
8585
colormap_name = viridis
8686

87+
# [optional] colormap set_under and set_over options
8788
under_color = k
8889
over_color = orange
8990

0 commit comments

Comments
 (0)