From c05eccd27bc65c9c4e701160b88d1fcc9cbeb007 Mon Sep 17 00:00:00 2001 From: Xylar Asay-Davis Date: Fri, 20 Oct 2023 13:39:48 +0200 Subject: [PATCH] Update user's guide --- .../ocean/tasks/correlated_tracers_2d.md | 46 ++++++++++--------- docs/users_guide/ocean/tasks/divergent_2d.md | 45 +++++++++--------- docs/users_guide/ocean/tasks/geostrophic.md | 40 ++++++++-------- .../ocean/tasks/nondivergent_2d.md | 46 ++++++++++--------- docs/users_guide/ocean/tasks/rotation_2d.md | 46 ++++++++++--------- 5 files changed, 120 insertions(+), 103 deletions(-) diff --git a/docs/users_guide/ocean/tasks/correlated_tracers_2d.md b/docs/users_guide/ocean/tasks/correlated_tracers_2d.md index aaadcab5d..313dbf5aa 100644 --- a/docs/users_guide/ocean/tasks/correlated_tracers_2d.md +++ b/docs/users_guide/ocean/tasks/correlated_tracers_2d.md @@ -217,19 +217,26 @@ temperature = 15. # salinity salinity = 35. -# time (days) for bell to transit equator once -vel_pd = 12.0 +# time (hours) for bell to transit equator once +vel_pd = 288.0 +# radius of cosine bells tracer distributions +cosine_bells_radius = 0.5 -# options for tracer visualization for the sphere transport test case -[sphere_transport_viz] +# background value of cosine bells tracer distribution +cosine_bells_background = 0.1 + +# amplitude of cosine bells tracer distribution +cosine_bells_amplitude = 0.9 -# visualization latitude and longitude resolution -dlon = 0.5 -dlat = 0.5 +# radius of slotted cylinders tracer distributions +slotted_cylinders_radius = 0.5 -# remapping method ('bilinear', 'neareststod', 'conserve') -remap_method = conserve +# background value of slotted cylinders tracer distribution +slotted_cylinders_background = 0.1 + +# amplitude of slotted cylinders tracer distribution +slotted_cylinders_amplitude = 1.0 # options for tracer visualization for the sphere transport test case @@ -242,11 +249,9 @@ 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.} +# colorbar limits +colorbar_limits = 0., 1. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_tracer_diff] @@ -258,8 +263,8 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 # options for thickness visualization for the sphere transport test case @@ -272,11 +277,9 @@ colormap_name = viridis # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': 99., 'vmax': 101.} +# colorbar limits +colorbar_limits = 99., 101. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_h_diff] @@ -288,8 +291,9 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 + # options for correlated tracers 2-d test case [correlated_tracers_2d] diff --git a/docs/users_guide/ocean/tasks/divergent_2d.md b/docs/users_guide/ocean/tasks/divergent_2d.md index 024d8c0f3..736133b46 100644 --- a/docs/users_guide/ocean/tasks/divergent_2d.md +++ b/docs/users_guide/ocean/tasks/divergent_2d.md @@ -206,19 +206,26 @@ temperature = 15. # salinity salinity = 35. -# time (days) for bell to transit equator once -vel_pd = 12.0 +# time (hours) for bell to transit equator once +vel_pd = 288.0 +# radius of cosine bells tracer distributions +cosine_bells_radius = 0.5 -# options for tracer visualization for the sphere transport test case -[sphere_transport_viz] +# background value of cosine bells tracer distribution +cosine_bells_background = 0.1 + +# amplitude of cosine bells tracer distribution +cosine_bells_amplitude = 0.9 + +# radius of slotted cylinders tracer distributions +slotted_cylinders_radius = 0.5 -# visualization latitude and longitude resolution -dlon = 0.5 -dlat = 0.5 +# background value of slotted cylinders tracer distribution +slotted_cylinders_background = 0.1 -# remapping method ('bilinear', 'neareststod', 'conserve') -remap_method = conserve +# amplitude of slotted cylinders tracer distribution +slotted_cylinders_amplitude = 1.0 # options for tracer visualization for the sphere transport test case @@ -231,11 +238,9 @@ 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.} +# colorbar limits +colorbar_limits = 0., 1. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_tracer_diff] @@ -247,8 +252,8 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 # options for thickness visualization for the sphere transport test case @@ -261,11 +266,9 @@ colormap_name = viridis # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': 99., 'vmax': 101.} +# colorbar limits +colorbar_limits = 99., 101. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_h_diff] @@ -277,8 +280,8 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 # options for divergent 2-d test case [divergent_2d] diff --git a/docs/users_guide/ocean/tasks/geostrophic.md b/docs/users_guide/ocean/tasks/geostrophic.md index f9f08ef06..59a0750e4 100644 --- a/docs/users_guide/ocean/tasks/geostrophic.md +++ b/docs/users_guide/ocean/tasks/geostrophic.md @@ -187,20 +187,10 @@ generous convergence threshold used here. Config options related to visualization are as follows. The options in `geostropnic_viz` are related to remapping to a regular latitude-longitude grid. The remaining options are related to plotting water-column thickness -(`h`) and velocities (`u`, `v` and `norm_vel`) and the difference between +(`h`) and velocities (`u` and `v`) and the difference between these fields at initialization and after the 5-day run. ```cfg -# options for visualization for the geostrophic convergence test case -[geostrophic_viz] - -# visualization latitude and longitude resolution -dlon = 0.5 -dlat = 0.5 - -# remapping method ('bilinear', 'neareststod', 'conserve') -remap_method = conserve - # options for plotting water-column thickness from the geostrophic test [geostrophic_viz_h] @@ -211,8 +201,11 @@ colormap_name = cmo.deep # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': 1000.0, 'vmax': 3000.0} +# colorbar limits +colorbar_limits = 1000.0, 3000.0 + +# colorbar label +label = water-column thickness (m) # options for plotting velocity from the geostrophic test [geostrophic_viz_vel] @@ -224,8 +217,11 @@ colormap_name = cmo.delta # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -40.0, 'vmax': 40.0} +# colorbar limits +colorbar_limits = -40.0, 40.0 + +# colorbar label +label = velocity (m/s) # options for plotting water-column thickness from the geostrophic test [geostrophic_viz_diff_h] @@ -237,8 +233,11 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -10.0, 'vmax': 10.0} +# colorbar limits +colorbar_limits = -10.0, 10.0 + +# colorbar label +label = water-column thickness (m) # options for plotting velocity from the geostrophic test [geostrophic_viz_diff_vel] @@ -250,8 +249,11 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.3, 'vmax': 0.3} +# colorbar limits +colorbar_limits = -0.3, 0.3 + +# colorbar label +label = velocity (m/s) ``` ## cores diff --git a/docs/users_guide/ocean/tasks/nondivergent_2d.md b/docs/users_guide/ocean/tasks/nondivergent_2d.md index 15d1ef71e..982551754 100644 --- a/docs/users_guide/ocean/tasks/nondivergent_2d.md +++ b/docs/users_guide/ocean/tasks/nondivergent_2d.md @@ -225,19 +225,26 @@ temperature = 15. # salinity salinity = 35. -# time (days) for bell to transit equator once -vel_pd = 12.0 +# time (hours) for bell to transit equator once +vel_pd = 288.0 +# radius of cosine bells tracer distributions +cosine_bells_radius = 0.5 -# options for tracer visualization for the sphere transport test case -[sphere_transport_viz] +# background value of cosine bells tracer distribution +cosine_bells_background = 0.1 + +# amplitude of cosine bells tracer distribution +cosine_bells_amplitude = 0.9 -# visualization latitude and longitude resolution -dlon = 0.5 -dlat = 0.5 +# radius of slotted cylinders tracer distributions +slotted_cylinders_radius = 0.5 -# remapping method ('bilinear', 'neareststod', 'conserve') -remap_method = conserve +# background value of slotted cylinders tracer distribution +slotted_cylinders_background = 0.1 + +# amplitude of slotted cylinders tracer distribution +slotted_cylinders_amplitude = 1.0 # options for tracer visualization for the sphere transport test case @@ -250,11 +257,9 @@ 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.} +# colorbar limits +colorbar_limits = 0., 1. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_tracer_diff] @@ -266,8 +271,8 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 # options for thickness visualization for the sphere transport test case @@ -280,11 +285,9 @@ colormap_name = viridis # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': 99., 'vmax': 101.} +# colorbar limits +colorbar_limits = 99., 101. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_h_diff] @@ -296,8 +299,9 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 + # options for nondivergent 2-d test case [nondivergent_2d] diff --git a/docs/users_guide/ocean/tasks/rotation_2d.md b/docs/users_guide/ocean/tasks/rotation_2d.md index 4fd90417e..9282b45e8 100644 --- a/docs/users_guide/ocean/tasks/rotation_2d.md +++ b/docs/users_guide/ocean/tasks/rotation_2d.md @@ -196,19 +196,26 @@ temperature = 15. # salinity salinity = 35. -# time (days) for bell to transit equator once -vel_pd = 12.0 +# time (hours) for bell to transit equator once +vel_pd = 288.0 +# radius of cosine bells tracer distributions +cosine_bells_radius = 0.5 -# options for tracer visualization for the sphere transport test case -[sphere_transport_viz] +# background value of cosine bells tracer distribution +cosine_bells_background = 0.1 + +# amplitude of cosine bells tracer distribution +cosine_bells_amplitude = 0.9 -# visualization latitude and longitude resolution -dlon = 0.5 -dlat = 0.5 +# radius of slotted cylinders tracer distributions +slotted_cylinders_radius = 0.5 -# remapping method ('bilinear', 'neareststod', 'conserve') -remap_method = conserve +# background value of slotted cylinders tracer distribution +slotted_cylinders_background = 0.1 + +# amplitude of slotted cylinders tracer distribution +slotted_cylinders_amplitude = 1.0 # options for tracer visualization for the sphere transport test case @@ -221,11 +228,9 @@ 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.} +# colorbar limits +colorbar_limits = 0., 1. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_tracer_diff] @@ -237,8 +242,8 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 # options for thickness visualization for the sphere transport test case @@ -251,11 +256,9 @@ colormap_name = viridis # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': 99., 'vmax': 101.} +# colorbar limits +colorbar_limits = 99., 101. -# We could provide colorbar tick marks but we'll leave the defaults -# colorbar_ticks = np.linspace(0., 1., 9) # options for plotting tracer differences from sphere transport tests [sphere_transport_viz_h_diff] @@ -267,8 +270,9 @@ colormap_name = cmo.balance # the type of norm used in the colormap norm_type = linear -# A dictionary with keywords for the norm -norm_args = {'vmin': -0.25, 'vmax': 0.25} +# colorbar limits +colorbar_limits = -0.25, 0.25 + # options for rotation 2-d test case [rotation_2d]