From accf5df5d6ba723a47679adf0f41831e7428eb2c Mon Sep 17 00:00:00 2001 From: Carolyn Begeman Date: Tue, 1 Oct 2024 09:27:18 -0500 Subject: [PATCH] Update docs --- docs/developers_guide/framework/visualization.md | 6 ++++++ docs/developers_guide/ocean/tasks/correlated_tracers_2d.md | 4 ++++ docs/developers_guide/ocean/tasks/divergent_2d.md | 4 ++++ docs/developers_guide/ocean/tasks/nondivergent_2d.md | 4 ++++ docs/developers_guide/ocean/tasks/rotation_2d.md | 4 ++++ polaris/ocean/tasks/sphere_transport/sphere_transport.cfg | 1 + 6 files changed, 23 insertions(+) diff --git a/docs/developers_guide/framework/visualization.md b/docs/developers_guide/framework/visualization.md index 7c5c4292d..ce15e0932 100644 --- 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 index 26d1cff6a..63c31402c 100644 --- 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 index b00faeb72..901936796 100644 --- 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 index 607e51db1..258396df9 100644 --- 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 index 3ebc2908a..4e2cd83a1 100644 --- 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 index cfe28ba71..731a4215e 100644 --- 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