Update the documentation

Author: xylar

docs/developers_guide/api.rst

@@ -78,6 +78,7 @@ Ocean tasks
    ClimatologyMapArgoSalinity
    ClimatologyMapWaves
    ClimatologyMapCustom
+   ClimatologyMapWindStressCurl
    GeojsonNetcdfTransects
    IndexNino34
    MeridionalHeatTransport
@@ -132,6 +133,8 @@ Ocean utilities
    add_standard_regions_and_subset
    get_standard_region_names
    compute_zmid
+   compute_zinterface
+   vector_cell_to_edge_isotropic
 
 
 Sea ice tasks

docs/users_guide/analysis_tasks.rst

@@ -23,6 +23,7 @@ Analysis Tasks
    tasks/climatologyMapSSH
    tasks/climatologyMapVel
    tasks/climatologyMapWaves
+   tasks/climatologyMapWindStressCurl
    tasks/climatologyMapWoa
 
    tasks/antshipTransects

docs/users_guide/tasks/climatologyMapWindStressCurl.rst

@@ -0,0 +1,68 @@
+.. _task_climatologyMapWindStressCurl:
+
+climatologyMapWindStressCurl
+============================
+
+An analysis task for plotting maps of wind stress curl.
+
+Component and Tags::
+
+  component: ocean
+  tags: climatology, horizontalMap, windStressCurl, publicObs
+
+Configuration Options
+---------------------
+
+The following configuration options are available for this task::
+
+    [climatologyMapWindStressCurl]
+    ## options related to plotting horizontally remapped climatologies of
+    ## wind stress curl against control model results
+
+    # colormap for model/observations
+    colormapNameResult = cmo.curl
+    # whether the colormap is indexed or continuous
+    colormapTypeResult = continuous
+    # color indices into colormapName for filled contours
+    # the type of norm used in the colormap
+    normTypeResult = linear
+    # A dictionary with keywords for the norm
+    normArgsResult = {'vmin': -1e-6, 'vmax': 1e-6}
+
+    # colormap for differences
+    colormapNameDifference = cmo.balance
+    # whether the colormap is indexed or continuous
+    colormapTypeDifference = continuous
+    # the type of norm used in the colormap
+    normTypeDifference = linear
+    # A dictionary with keywords for the norm
+    normArgsDifference = {'vmin': -2e-7, 'vmax': 2e-7}
+
+    # Months or seasons to plot (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
+    # Nov, Dec, JFM, AMJ, JAS, OND, ANN)
+    seasons =  ['ANN']
+
+    # comparison grid(s) on which to plot analysis
+    comparisonGrids = ['latlon']
+
+For analysis focused on polar regions (using the ``--polar_regions`` flag),
+the following config options add Arctic and Antarctic comparison grids::
+
+    [climatologyMapWindStressCurl]
+    ## options related to plotting horizontally remapped climatologies of
+    ## wind stress curl against control model results
+
+    # comparison grid(s) on which to plot analysis
+    comparisonGrids = ['latlon', 'arctic_extended', 'antarctic_extended']
+
+For more details, see:
+ * :ref:`config_colormaps`
+ * :ref:`config_seasons`
+ * :ref:`config_comparison_grids`
+
+Example Result
+--------------
+
+.. image:: examples/wind_stress_curl.png
+   :width: 500 px
+   :align: center