Update docs

E3SM-Project · Oct 1, 2024 · accf5df · accf5df
1 parent b8cd032
commit accf5df
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 0 deletions.
diff --git a/docs/developers_guide/framework/visualization.md b/docs/developers_guide/framework/visualization.md
@@ -154,7 +154,13 @@ colormap).
 
 The `colorbar_limits` are the lower and upper bound of the colorbar range.
 
+There are also two optional config options used to set the colors on either end of the colormap:
 
+```cfg
+# [optional] colormap set_under and set_over options
+under_color = k
+over_color = orange
+```
 ### plotting from lat/lon grids
 
 You can use {py:func}`polaris.viz.plot_global_lat_lon_field()` to plot a field 

diff --git a/docs/developers_guide/ocean/tasks/correlated_tracers_2d.md b/docs/developers_guide/ocean/tasks/correlated_tracers_2d.md
@@ -77,6 +77,10 @@ each resolution.  The colormap is controlled by these options:
 # colormap
 colormap_name = viridis
 
+# [optional] colormap set_under and set_over options
+under_color = k
+over_color = orange
+
 # the type of norm used in the colormap
 norm_type = linear
 

diff --git a/docs/developers_guide/ocean/tasks/divergent_2d.md b/docs/developers_guide/ocean/tasks/divergent_2d.md
@@ -71,6 +71,10 @@ each resolution.  The colormap is controlled by these options:
 # colormap
 colormap_name = viridis
 
+# [optional] colormap set_under and set_over options
+under_color = k
+over_color = orange
+
 # the type of norm used in the colormap
 norm_type = linear
 

diff --git a/docs/developers_guide/ocean/tasks/nondivergent_2d.md b/docs/developers_guide/ocean/tasks/nondivergent_2d.md
@@ -77,6 +77,10 @@ each resolution.  The colormap is controlled by these options:
 # colormap
 colormap_name = viridis
 
+# [optional] colormap set_under and set_over options
+under_color = k
+over_color = orange
+
 # the type of norm used in the colormap
 norm_type = linear
 

diff --git a/docs/developers_guide/ocean/tasks/rotation_2d.md b/docs/developers_guide/ocean/tasks/rotation_2d.md
@@ -71,6 +71,10 @@ each resolution.  The colormap is controlled by these options:
 # colormap
 colormap_name = viridis
 
+# [optional] colormap set_under and set_over options
+under_color = k
+over_color = orange
+
 # the type of norm used in the colormap
 norm_type = linear
 

diff --git a/polaris/ocean/tasks/sphere_transport/sphere_transport.cfg b/polaris/ocean/tasks/sphere_transport/sphere_transport.cfg
@@ -84,6 +84,7 @@ slotted_cylinders_amplitude = 1.0
 # colormap
 colormap_name = viridis
 
+# [optional] colormap set_under and set_over options
 under_color = k
 over_color = orange