LEX v0.1-rc3 release

This release candidate includes:

* better documentation 
* better colors in many of the plots
* the postprocessing scripts used to produce the model data

LICENSE

+Copyright (c) 2018, UT-BATTELLE, LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

README.rst

@@ -4,7 +4,7 @@
 LIVVkit Extensions (LEX)
 ========================
 
-This repository holds a collection of extension to`LIVVkit <https://livvkit.github.io/Docs/index.html>`_
+This repository holds a collection of extensions to `LIVVkit <https://livvkit.github.io/Docs/index.html>`_
 for validation and custom analyses of ice sheet models and their associated Earth
 system models.
 
@@ -24,18 +24,12 @@ uses `git-lfs <https://git-lfs.github.com>`_ (Git Large File Support) in order t
 distribute the required data. ``git-lfs`` can be installed either before or after
 cloning this repository, but it will be needed *before* downloading the required
 data. You can determine if you have ``git-lfs`` installed on your system by running
-this command in POSIX compliant shells (`bash`, `zsh`, `fish`, etc.):
+this command in POSIX compliant shells (``bash``, ``zsh``, ``fish``, etc.):
 
 .. code:: bash
 
     command -v git-lfs
 
-or this command in `csh` variants:
-
-.. code:: csh
-
-    which git-lfs
-
 If ``git-lfs`` is not installed, you can install it by following the instructions here:
 
 https://git-lfs.github.com
@@ -87,7 +81,7 @@ top level ``lex`` directory. You *can* run any of these extensions from any
 directory, but you will need to edit the paths in the JSON configuration files so
 that ``livv`` can find the required files.
 
-Likewise, you can also apply these analyses to any new model run [#]_ py adjusting
+Likewise, you can also apply these analyses to any new model run [#]_ by adjusting
 the paths to point to your model run.
 
 .. [#] You may find `this tutorial by Atlassian useful <https://www.atlassian.com/git/tutorials/git-lfs>`_.
@@ -117,11 +111,17 @@ into the directory ``lex``, you can reproduce all the figures and tables in
                     -o vv_evans2018 -s
 
 
+All the *model* data used for these analyses, and provided as an example, required some
+postprocessing to generate the required input data for analysis with LIVVkit. A set of task-parallel
+postprocessing scripts are provided in the ``postproc`` directory. While these scripts are
+currently model specific, a new model can be adapted from current scripts using the directions in
+the `postprocessing README <https://code.ornl.gov/LIVVkit/lex/blob/master/postproc/README.md>`__.
+Note: A more generalized method of postprocessing model data is currently under development.
 
 Developing a custom extension
 -----------------------------
 
-See the `LIVVkit documentation <https://livvkit.github.io/Docs/extend.html>`_ for
+See the `LIVVkit documentation <https://livvkit.github.io/Docs/lex.html>`_ for
 details on how to develop an extension. Briefly, a absolute minimum working example
 is provided by the ``examples/`` extension, which should be copied to provide the
 basis for your new extension. All extensions are required to contain a minimal working
@@ -149,4 +149,4 @@ Want to send us a private message?
 :github: @kevans32
 :email: evanskj@ornl.gov
 
-*Note: If you're emailing us, we recommend CC-ing all of us.*
+*Note: If you're emailing us, we recommend CC-ing all of us.*
\ No newline at end of file

VERSION

+version = 0.1-rc3
\ No newline at end of file

clouds/clouds/cesm_cldhgh_ann.py

@@ -63,8 +63,8 @@ def make_plot(config, out_path='.'):
 
     # ------- PLOT --------
     # Open a workstation for drawing the plots
+    cmap = ["grey98","grey94","grey90","grey86","grey80","grey74","grey68","grey60","grey52","grey44","grey36"]
     wkres = Ngl.Resources()
-    wkres.wkColorMap = "BlueWhiteOrangeRed"
     # wkres.wkOrientation = "portrait"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, 'CESM_cldhgh_ANN'))
@@ -93,6 +93,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the CESM contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "percent_11lev"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -111,6 +112,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the data contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "percent_11lev"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -130,6 +132,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the data contour -------
     res3 = Ngl.Resources()
+    res3.cnFillPalette = "percent_11lev"
     res3.nglDraw = False  # Don't draw individual plots
     res3.nglFrame = False  # Don't advance frame.
     res3.cnLineLabelsOn = False

clouds/clouds/cesm_cldlow_ann.py

@@ -63,9 +63,8 @@ def make_plot(config, out_path='.'):
 
     # ------- PLOT --------
     #  Open a workstation for drawing the plots
+    #cmap = ["grey98","grey94","grey90","grey86","grey80","grey74","grey68","grey60","grey52","grey44","grey36"]
     wkres = Ngl.Resources()
-    # wkres.wkColorMap = "WhiteBlueGreenYellowRed"
-    wkres.wkColorMap = "BlueWhiteOrangeRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CESM_cldlow_ANN"))
@@ -93,6 +92,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the CESM contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "percent_11lev"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -111,6 +111,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the data contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "percent_11lev"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -130,6 +131,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the data contour -------
     res3 = Ngl.Resources()
+    res3.cnFillPalette = "percent_11lev"
     res3.nglDraw = False  # Don't draw individual plots
     res3.nglFrame = False  # Don't advance frame.
     res3.cnLineLabelsOn = False

clouds/clouds/cesm_cldtot_ann.py

@@ -63,9 +63,8 @@ def make_plot(config, out_path='.'):
     
     # ------- PLOT --------
     #  Open a workstation for drawing the plots
+    cmap = ["grey98","grey94","grey90","grey86","grey80","grey74","grey68","grey60","grey52","grey44","grey36"]
     wkres = Ngl.Resources()
-    # wkres.wkColorMap = "WhiteBlueGreenYellowRed"
-    wkres.wkColorMap = "BlueWhiteOrangeRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CESM_cldtot_ANN"))
@@ -93,6 +92,7 @@ def make_plot(config, out_path='.'):
     
     # --- for the CESM contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "percent_11lev"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -111,6 +111,7 @@ def make_plot(config, out_path='.'):
     
     # --- for the data contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "percent_11lev"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -130,6 +131,7 @@ def make_plot(config, out_path='.'):
     
     # --- for the data contour -------
     res3 = Ngl.Resources()
+    res3.cnFillPalette = "percent_11lev"
     res3.nglDraw = False  # Don't draw individual plots
     res3.nglFrame = False  # Don't advance frame.
     res3.cnLineLabelsOn = False

dynamics/dynamics/cisma_js_standalone.py

@@ -60,7 +60,6 @@ def make_plot(config, out_path='.'):
     # ------- PLOT --------
     # Open a workstation for drawing the plots
     wkres = Ngl.Resources()
-    wkres.wkColorMap = "WhiteBlueGreenYellowRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CISMA_js"))
@@ -89,6 +88,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file1 contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "WhiteYellowOrangeRed"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -109,6 +109,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file2 contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "WhiteYellowOrangeRed"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -129,6 +130,7 @@ def make_plot(config, out_path='.'):
 
     # --- for diff=file1-file2 contour -------
     res22 = Ngl.Resources()
+    res22.cnFillPalette = "BlueWhiteOrangeRed"
     res22.nglDraw = False  # Don't draw individual plots
     res22.nglFrame = False  # Don't advance frame.
     res22.cnLineLabelsOn = False
@@ -138,7 +140,7 @@ def make_plot(config, out_path='.'):
     res22.cnFillMode = "RasterFill"
     res22.trGridType = "TriangularMesh"
     res22.cnLevelSelectionMode = "ExplicitLevels"
-    res22.cnLevels = (0, 1, 2, 10, 30, 70, 100, 200, 500, 1000, 2000)
+    res22.cnLevels = (-500,-200,-100,-75,-50,-10,0,10,50,75,100,200,500)
     res22.lbLabelBarOn = True  # Turn on labelbar.
     res22.lbOrientation = "Horizontal"  # Verticle labelbar
     res22.lbLabelFontHeightF = 0.02  # Make fonts smaller.

dynamics/dynamics/cisma_pm_standalone.py

@@ -60,7 +60,6 @@ def make_plot(config, out_path='.'):
     # ------- PLOT --------
     # Open a workstation for drawing the plots
     wkres = Ngl.Resources()
-    wkres.wkColorMap = "WhiteBlueGreenYellowRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CISMA_pm"))
@@ -89,6 +88,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file1 contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "WhiteYellowOrangeRed"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -109,6 +109,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file2 contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "WhiteYellowOrangeRed"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -129,6 +130,7 @@ def make_plot(config, out_path='.'):
 
     # --- for diff=file1-file2 contour -------
     res22 = Ngl.Resources()
+    res22.cnFillPalette = "BlueWhiteOrangeRed"
     res22.nglDraw = False  # Don't draw individual plots
     res22.nglFrame = False  # Don't advance frame.
     res22.cnLineLabelsOn = False
@@ -138,7 +140,7 @@ def make_plot(config, out_path='.'):
     res22.cnFillMode = "RasterFill"
     res22.trGridType = "TriangularMesh"
     res22.cnLevelSelectionMode = "ExplicitLevels"
-    res22.cnLevels = (0, 1, 2, 10, 30, 70, 100, 200, 500, 1000, 2000)
+    res22.cnLevels = (-500,-200,-100,-75,-50,-10,0,10,50,75,100,200,500)
     res22.lbLabelBarOn = True  # Turn on labelbar.
     res22.lbOrientation = "Horizontal"  # Verticle labelbar
     res22.lbLabelFontHeightF = 0.02  # Make fonts smaller.

dynamics/dynamics/cisma_racmo23_standalone.py

@@ -81,7 +81,6 @@ def make_plot(config, out_path='.'):
     # ------- PLOT --------
     #  Open a workstation for drawing the plots
     wkres = Ngl.Resources()
-    wkres.wkColorMap = "WhiteBlueGreenYellowRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CISMA_RACMO23"))
@@ -110,6 +109,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file1 contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "BlueWhiteOrangeRed"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -132,6 +132,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file2 contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "BlueWhiteOrangeRed"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -154,6 +155,7 @@ def make_plot(config, out_path='.'):
 
     # --- for diff=file1-file2 contour -------
     res22 = Ngl.Resources()
+    res22.cnFillPalette = "BlueWhiteOrangeRed"
     res22.nglDraw = False  # Don't draw individual plots
     res22.nglFrame = False  # Don't advance frame.
     res22.cnLineLabelsOn = False

dynamics/dynamics/cisma_temp_standalone.py

@@ -46,7 +46,6 @@ def make_plot(config, out_path='.'):
     # ------- PLOT --------
     #  Open a workstation for drawing the plots
     wkres = Ngl.Resources()
-    wkres.wkColorMap = "WhiteBlueGreenYellowRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CISMA_temp"))
@@ -75,6 +74,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file1 contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "WhiteBlue"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -95,6 +95,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file2 contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "WhiteBlue"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -115,6 +116,7 @@ def make_plot(config, out_path='.'):
 
     # --- for diff=file1-file2 contour -------
     res22 = Ngl.Resources()
+    res22.cnFillPalette = "BlueWhiteOrangeRed"
     res22.nglDraw = False  # Don't draw individual plots
     res22.nglFrame = False  # Don't advance frame.
     res22.cnLineLabelsOn = False

dynamics/dynamics/cisma_velnorm_standalone.py

@@ -59,7 +59,6 @@ def make_plot(config, out_path='.'):
     # ------- PLOT --------
     # Open a workstation for drawing the plots
     wkres = Ngl.Resources()
-    wkres.wkColorMap = "WhiteBlueGreenYellowRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CISMA_velnorm"))
@@ -88,6 +87,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file1 contour -------
     res1 = Ngl.Resources()
+    res1.cnFillPalette = "WhiteYellowOrangeRed"
     res1.nglDraw = False  # Don't draw individual plots
     res1.nglFrame = False  # Don't advance frame.
     res1.cnLineLabelsOn = False
@@ -108,6 +108,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file2 contour -------
     res2 = Ngl.Resources()
+    res2.cnFillPalette = "WhiteYellowOrangeRed"
     res2.nglDraw = False  # Don't draw individual plots
     res2.nglFrame = False  # Don't advance frame.
     res2.cnLineLabelsOn = False
@@ -128,6 +129,7 @@ def make_plot(config, out_path='.'):
 
     # --- for diff=file1-file2 contour -------
     res22 = Ngl.Resources()
+    res22.cnFillPalette = "BlueWhiteOrangeRed"
     res22.nglDraw = False  # Don't draw individual plots
     res22.nglFrame = False  # Don't advance frame.
     res22.cnLineLabelsOn = False
@@ -137,7 +139,7 @@ def make_plot(config, out_path='.'):
     res22.cnFillMode = "RasterFill"
     res22.trGridType = "TriangularMesh"
     res22.cnLevelSelectionMode = "ExplicitLevels"
-    res22.cnLevels = (0, 1, 2, 10, 30, 70, 100, 200, 500, 1000, 2000)
+    res22.cnLevels = (-500,-200,-100,-75,-50,-10,0,10,50,75,100,200,500)
     res22.lbLabelBarOn = True  # Turn on labelbar.
     res22.lbOrientation = "Horizontal"  # Verticle labelbar
     res22.lbLabelFontHeightF = 0.02  # Make fonts smaller.

dynamics/dynamics/cisma_zach_standalone.py

@@ -60,7 +60,6 @@ def make_plot(config, out_path='.'):
     # ------- PLOT --------
     # Open a workstation for drawing the plots
     wkres = Ngl.Resources()
-    wkres.wkColorMap = "WhiteBlueGreenYellowRed"
     # wkres.wkOrientation = "portrait"  # "portrait" or "landscape"
     wks_type = "png"
     wks_img = str(os.path.join(out_path, "CISMA_zach"))
@@ -89,6 +88,7 @@ def make_plot(config, out_path='.'):
 
     # --- for the file1 contour -------
     res1 = Ngl.Resources()