Legend offset new attribute (#2069)

* gfortran not needed any longer on mac

* added offset attriubte

* ok legend now works

* added a bunch of tests, make sure line is drawn once only

* got legend_2 to work

* pep8ed and flake8ed

* Update VCS_validation_functions.py

* get text offset a bit smaller

* huge bug in extension and levels setting, fixed now

* updated correct json file to reflect new attributes

* updated correct json file to reflect new attributes

* apparently matplotlib cmaps need cycler

* reverted update baselines to False and cleaned up styling

* seems like sometimes activating fails, sticking th activation in a loop

I suspects the fail is due to some concurency issue so repeating for a while should eventually work

* adding clean-local to cmake

Author: doutriaux1

.travis.yml

@@ -10,7 +10,6 @@ before_install:
   - if [ "$TRAVIS_OS_NAME" = "linux" ]; then wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh; fi
   - if [ "$TRAVIS_OS_NAME" = "osx" ]; then brew update ; fi 
   - if [ "$TRAVIS_OS_NAME" = "osx" ]; then wget https://repo.continuum.io/miniconda/Miniconda-latest-MacOSX-x86_64.sh -O miniconda.sh; fi
-  - if [ "$TRAVIS_OS_NAME" = "osx" ]; then wget https://github.com/UV-CDAT/uvcdat/releases/download/v2.4.1/gfortran-4.9.2-Mac.tar.gz -O ~/gfortran-4.9.2-Mac.tar.gz ; pushd / ; sudo tar xzvf ~/gfortran-4.9.2-Mac.tar.gz ; pushd ; fi
   - export PATH="$HOME/miniconda/bin:$PATH"
   - bash miniconda.sh -b -p $HOME/miniconda
   - conda config --set always_yes yes --set changeps1 no

CMake/cdat_modules_extra/clean_local_build.bash.in

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+echo "Clean build directory:"@CMAKE_BINARY_DIR@
+cd @CMAKE_BINARY_DIR@
+rm -rf CMake* CTestTestfile.cmake  DartConfiguration.tcl  Makefile Testing/ cmake_install.cmake version CDAT-prefix

CMake/cdat_modules_extra/install_cdat_from_conda.bash.in

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-@CONDA@ create -y -n @CONDA_ENVIRONMENT_NAME@ -c @CONDA_CHANNEL_UVCDAT@  hdf5 libnetcdf lapack clapack ossuuid libcf esmf jasper g2clib yasm x264 ffmpeg cmor proj4>=4.9.2 vtk libcdms cdat_info flake8 requests numpy==1.9.2 matplotlib --show-channel-urls --copy
+@CONDA@ create -y -n @CONDA_ENVIRONMENT_NAME@ -c @CONDA_CHANNEL_UVCDAT@  hdf5 libnetcdf lapack clapack ossuuid libcf esmf jasper g2clib yasm x264 ffmpeg cmor proj4>=4.9.2 vtk libcdms cdat_info flake8 requests numpy==1.9.2 cycler matplotlib --show-channel-urls --copy
 
 source @ACTIVATE@ @CONDA_ENVIRONMENT_NAME@
 for pkg in testing cdtime regrid2 cdms2 esg DV3D vcs vcsaddons cdutil unidata xmgrace genutil Thermo WK distarray; do

CMake/cdat_modules_extra/runtest.in

@@ -1,6 +1,9 @@
 #!/bin/bash
 echo "ACTIVATING ENV:"@CONDA_ENVIRONMENT_NAME@
-source activate @CONDA_ENVIRONMENT_NAME@
+while [[ `which python` != *"@CONDA_ENVIRONMENT_NAME@"* ]]
+do
+    source activate @CONDA_ENVIRONMENT_NAME@
+done
 export DYLD_FALLBACK_LIBRARY_PATH=`python -c "import sys,os;print os.path.join(sys.prefix,'lib')"`
 echo "Python:" `which python`
 echo "Running: "$*

CMakeLists.txt

@@ -292,9 +292,19 @@ configure_file(${cdat_CMAKE_SOURCE_DIR}/cdat_modules_extra/clean_cdat_from_conda
     ${cdat_CMAKE_BINARY_DIR}/clean_cdat_from_conda.bash
     @ONLY
     )
+
+configure_file(${cdat_CMAKE_SOURCE_DIR}/cdat_modules_extra/clean_local_build.bash.in
+    ${cdat_CMAKE_BINARY_DIR}/clean_local_build.bash
+    @ONLY
+    )
 add_subdirectory(testing)
 
 # Clean conda env
 add_custom_target(clean-conda
     COMMAND ${cdat_CMAKE_BINARY_DIR}/clean_cdat_from_conda.bash
     )
+
+# Clean local env
+add_custom_target(clean-local
+    COMMAND ${cdat_CMAKE_BINARY_DIR}/clean_local_build.bash
+    )

Packages/testing/regression.py

@@ -83,7 +83,7 @@ def find_alternates(fname):
     return results
 
 def check_result_image(fname, baselinefname=sys.argv[1], threshold=defaultThreshold,
-                       baseline=True, cleanup=True, update_baselines = False, suffix="_2"):
+                       baseline=True, cleanup=True, update_baselines = False, suffix="_1"):
     testImage = image_from_file(fname)
     if testImage is None:
         print "Testing image missing, test failed."

Packages/vcs/vcs/Plegend.py

@@ -93,7 +93,12 @@ class Pls(object):
         "_texttable",
         "_textorientation",
         "texttable",
-        "textorientation"]
+        "textorientation",
+        "offset",
+        "_offset",
+        "arrow",
+        "_arrow",
+    ]
 
     def __init__(self, member):
         #    def __init__(self, template, member=None):
@@ -115,6 +120,8 @@ def __init__(self, member):
         self.y1 = 0.129999995232
         self.x2 = 0.949999988079
         self.y2 = 0.159999996424
+        self.offset = .01
+        self.arrow = .05
 
     ##########################################################################
     #                                                                           #
@@ -129,6 +136,8 @@ def __init__(self, member):
     line = VCS_validation_functions.line
     texttable = VCS_validation_functions.texttable
     textorientation = VCS_validation_functions.textorientation
+    offset = VCS_validation_functions.offset
+    arrow = VCS_validation_functions.arrow
 
     ##########################################################################
     #                                                                           #
@@ -145,6 +154,7 @@ def list(self):
         print "     line =", self.line
         print "     texttable =", self.texttable
         print "     textorientation =", self.textorientation
+        print "     offset =", self.offset
 
 
 ##########################################################################

Packages/vcs/vcs/VCS_validation_functions.py

@@ -716,7 +716,7 @@ def checkListTuple(self, name, value):
     # Now make sure the items are either number or listofnumbers
     # for v in value:
     checkName(self, name, value)
-    if isinstance(value, list) or isinstance(value, tuple):
+    if isinstance(value, (list, tuple)):
         return list(value)
     else:
         checkedRaise(
@@ -1745,13 +1745,37 @@ def _setpriority(self, value):
 priority = property(_getpriority, _setpriority)
 
 
-def _getX1(self):
+@property
+def arrow(self):
+    """length of extension arrows"""
+    return self._arrow
+
+
+@arrow.setter
+def arrow(self, value):
+    self._arrow = checkNumber(self, "arrow", value, 0., None)
+
+
+@property
+def offset(self):
+    """offset position of legend labels from legend colorbar, in % of page (can be negative)"""
+    return self._offset
+
+
+@offset.setter
+def offset(self, value):
+    self._offset = checkNumber(self, "offset", value, -1., 1.)
+
+
+@property
+def x1(self):
+    """x1 position in % of page"""
     return self._x1
 
 
-def _setX1(self, value):
+@x1.setter
+def x1(self, value):
     self._x1 = checkNumber(self, "x1", value, 0., 1.)
-x1 = property(_getX1, _setX1, "x1 position in % of page")
 
 
 def _getX2(self):
@@ -1852,18 +1876,21 @@ def _setcolormap(self, value):
 colormap = property(_getcolormap, _setcolormap)
 
 
-def _getlevels(self):
+@property
+def levels(self):
+    """Sets the levels on a graphic method, optionally turns on/off extensions arrows"""
     return self._levels
 
 
-def _setlevels(self, value):
-    if value == ([1.0000000200408773e+20, 1.0000000200408773e+20],):
+@levels.setter
+def levels(self, value):
+    value = list(checkListTuple(self, 'levels', value))
+
+    if len(value) == 2 and numpy.allclose(value, 1.e20):
         self._levels = value
         return
 
-    value = list(checkListTuple(self, 'levels', value))
-
-    # Now make sure the items are either number or listofnumbers
+    # Now make sure the items are either number or list of numbers
     for v in value:
         if isNumber(v):
             continue
@@ -1891,17 +1918,23 @@ def _setlevels(self, value):
             value[0], (list, tuple)) and len(value[0]) > 2:
         value = list(value[0])
 
-    if (value[0] < -9.9E19):
+    # We need to check for extensions
+    v = value[0]
+    if isinstance(v, (list, tuple)):
+        v = v[0]
+    if v < -9.9E19:
         self._ext_1 = True
     else:
         self._ext_1 = False
 
-    if (value[-1] > 9.9E19):
+    v = value[-1]
+    if isinstance(v, (list, tuple)):
+        v = v[-1]
+    if v > 9.9E19:
         self._ext_2 = True
     else:
         self._ext_2 = False
     self._levels = list(value)
-levels = property(_getlevels, _setlevels)
 
 
 def _getlegend(self):
@@ -1964,7 +1997,7 @@ def add_level_ext_1(self, ext_value):
     if ext_value == "n":
         return self.levels
 
-    # We may need to add extnsion
+    # We may need to add extension
     if isinstance(self.levels, (list, tuple)):
         if isinstance(self.levels, tuple):
             self.levels = list(self.levels)
@@ -2004,9 +2037,10 @@ def add_level_ext_2(self, ext_value):
     if self.levels == [] or numpy.allclose(self.levels, 1.e20):
         return self.levels  # nothing to do
     if ((ext_value == 'n') and self.ext_2):  # remove extension
-        if isinstance(self.levels[0], list):  # remove from tuple of lists
+        if isinstance(self.levels[-1], list):  # remove from tuple of lists
             if self.levels[-1][1] > 9.e19:
                 self.levels.pop(-1)
+                return
         if isinstance(self.levels, (tuple, list)):       # remove from list
             ret_tup = []
             for i in range(len(self.levels) - 1):
@@ -2033,32 +2067,36 @@ def add_level_ext_2(self, ext_value):
         return self.levels
 
 
-def _getext_1(self):
+@property
+def ext_1(self):
+    """Turns on extensions arrows for values before the first level"""
     return self._ext_1
 
 
-def _setext_1(self, value):
+@ext_1.setter
+def ext_1(self, value):
     do = checkExt(self, 'ext_1', value)
     if do:
         add_level_ext_1(self, 'y')
     else:
         add_level_ext_1(self, 'n')
     self._ext_1 = do
-ext_1 = property(_getext_1, _setext_1)
 
 
-def _getext_2(self):
+@property
+def ext_2(self):
+    """Turns on extensions arrows for values after the last level"""
     return self._ext_2
 
 
-def _setext_2(self, value):
+@ext_2.setter
+def ext_2(self, value):
     do = checkExt(self, 'ext_2', value)
     if do:
         add_level_ext_2(self, 'y')
     else:
         add_level_ext_2(self, 'n')
     self._ext_2 = do
-ext_2 = property(_getext_2, _setext_2)
 
 
 def _getwc(self):