Merge pull request #9 from UV-CDAT/viewer

Viewer

Author: zshaheen

cdp/cdp_driver.py

@@ -1,4 +1,5 @@
 import abc
+import sys
 import cdp.cdp_tool
 import cdp._cache
 
@@ -28,35 +29,35 @@ class CDPMetric(cdp.cdp_tool.CDPTool):
 
     __metaclass__ = abc.ABCMeta
 
-    def __init__(self, metric_path=None):
-        # metric_path: printed when this metric is used.
-        #  Let's users know when a metric is called in the code.
+    def __init__(self, metric_name=None):
+        #  metric_info: information displayed when the metric is used.
         # _values: dictionary of the computed values. This allows for compound metrics.
-        self._metric_path = metric_path
-        # get the 'filename' from /path/to/filename.py
-        name_with_py = self._metric_path.split('/')[-1]
-        name = name_with_py.split('.')[0]
-        self._values = {name: self}
+        self.metric_info = None
+        if metric_name is None:
+            metric_name = sys.modules[self.__class__.__module__].__file__  # gets the path of the file
+            metric_name = metric_name.split('/')[-1].split('.')[0]  # get the 'filename' from /path/to/filename.py
+        self._values = {metric_name: self}
 
     def __call__(self, *args, **kwargs):
         self._show_metric_information()
         if self._is_compound():
-            # Remove the 'CompoundMetric' key from the _values because it's just a key with a blank value
-            self._values.pop('CompoundMetric')
+            # Remove the 'cdp_metric' key from the _values because 
+            # it's just a key with a blank value created when there's a compound metric
+            self._values.pop('cdp_metric')
             # loop through and calculate all of the metrics
             for key, value in self._values.items():
                 # replaces the function with the actual value
                 self._values[key] = value(*args, **kwargs)
             return self._values
         else:
             #return cdp._cache.cache(self.compute, *args, **kwargs)
-	    return self.compute(*args, **kwargs)
+	        return self.compute(*args, **kwargs)
 
     def __add__(self, other):
         class CompoundMetric(CDPMetric):
             def compute(self):
                 pass
-        compound_metric = CompoundMetric('CompoundMetric')
+        compound_metric = CompoundMetric()
         self._add_values_dict_into_first(compound_metric, self)
         self._add_values_dict_into_first(compound_metric, other)
         return compound_metric
@@ -67,7 +68,7 @@ def compute(self):
                 pass
         if not self._is_compound():
             raise TypeError('First operand must be a CompoundMetric')
-        compound_metric = CompoundMetric('CompoundMetric')
+        compound_metric = CompoundMetric()
         self._add_values_dict_into_first(compound_metric, self)
         self._subtract_values_dict_into_first(compound_metric, other)
         return compound_metric
@@ -93,7 +94,13 @@ def _subtract_values_dict_into_first(self, compound_metric, other_metric):
     def _show_metric_information(self):
         """ Displays information about this metric so that a user
         can easily identify what metrics are being used. """
-        print 'Using metric: ' + self._metric_path
+        if self.metric_info:
+            print self.metric_info
+
+    def set_metric_info(self, info):
+        ''' Sets a message to be displayed everytime 
+        a metric is called. Useful for debugging. '''
+        self.metric_info = info
 
     @abc.abstractmethod
     def compute(self):

cdp/cdp_metric.py

@@ -0,0 +1,57 @@
+import os
+import stat
+from output_viewer.build import build_viewer
+from output_viewer.utils import rechmod
+from output_viewer.index import OutputIndex, OutputPage, OutputFile, OutputRow, OutputGroup
+
+
+class OutputViewer(object):
+    def __init__(self, path='.', index_name='Results'):
+        self.path = os.path.abspath(path)
+        self.index = OutputIndex(index_name)
+        self.group = None
+        self.page = None
+
+    def add_group(self, name):
+        self.group = OutputGroup(name)
+        self.page.addGroup(self.group)
+
+    def add_page(self, name, cols):
+        self.page = OutputPage(name, cols)
+        self.index.addPage(self.page)
+
+    def add_row(self, *args, **kwargs):
+        ''' Adds a description and all of the files in self.path to an
+        OutputRow, which is then added to the current page'''
+        cols = []
+        for arg in args[1:]:
+            cols.append(arg)
+        file_path = os.path.abspath(kwargs['file_name'])
+        cols.append(OutputFile(file_path))
+
+        if self.group is None:
+            self.group = OutputGroup('Variables for this data set')
+            self.page.addGroup(self.group)
+        if self.page is not None:
+            row = OutputRow(args[0], cols)
+            self.page.addRow(row, len(self.page.groups)-1)
+        else:
+            raise RuntimeError('You need to add a page with add_page() before calling add_row()')
+
+    def generate_viewer(self):
+        self.index.toJSON(os.path.join(self.path, "index.json"))
+
+        default_mask = stat.S_IMODE(os.stat(self.path).st_mode)
+        rechmod(self.path, default_mask)
+
+        if os.access(self.path, os.W_OK):
+            default_mask = stat.S_IMODE(os.stat(self.path).st_mode)  # mode of files to be included
+            build_viewer(os.path.join(self.path, "index.json"), diag_name="My Diagnostics", default_mask=default_mask)
+
+        if os.path.exists(os.path.join(self.path, "index.html")):
+            should_open = raw_input("Viewer HTML generated at %s/index.html. Would you like to open in a browser? y/[n]: " % self.path)
+            if should_open and should_open.lower()[0] == "y":
+                import webbrowser
+                webbrowser.open("file://" + os.path.join(self.path, "index.html"))
+        else:
+            raise RuntimeError("Failed to generate the viewer.")

cdp/cdp_viewer.py

@@ -5,18 +5,10 @@
 class TestCDPMetric(unittest.TestCase):
 
     class Add(cdp.cdp_metric.CDPMetric):
-        def __init__(self):
-            metric_path = 'add'
-            super(TestCDPMetric.Add, self).__init__(metric_path)
-
         def compute(self, a1, a2):
             return a1 + a2
 
     class Sub(cdp.cdp_metric.CDPMetric):
-        def __init__(self):
-            metric_path = 'sub'
-            super(TestCDPMetric.Sub, self).__init__(metric_path)
-
         def compute(self, s1, s2):
             return s1 - s2
 
@@ -36,8 +28,8 @@ def test_compute(self):
 
     def test_add(self):
         try:
-            sub = TestCDPMetric.Sub()
-            add = TestCDPMetric.Add()
+            sub = TestCDPMetric.Sub('sub')
+            add = TestCDPMetric.Add('add')
             new_metric = sub + add
             result = new_metric(2, 1)
             self.assertDictEqual(result, {'add':3, 'sub':1})
@@ -46,15 +38,16 @@ def test_add(self):
 
     def test_sub(self):
         try:
-            sub = TestCDPMetric.Sub()
-            add = TestCDPMetric.Add()
+            sub = TestCDPMetric.Sub('sub')
+            add = TestCDPMetric.Add('add')
             compound_metric = sub + add
             new_metric = compound_metric - sub
             result = new_metric(2, 1)
             self.assertDictEqual(result, {'add':3})
         except Exception as err:
             self.fail('Failure during metric subtraction: %s' % err)
 
+
     def test_is_compound(self):
         sub = TestCDPMetric.Sub()
         add = TestCDPMetric.Add()

cdp/test/test_cdp_metric.py

@@ -14,3 +14,5 @@ requirements:
   build:
     - python
     - setuptools
+  run:
+    - output_viewer

conda/meta.yaml

@@ -0,0 +1,26 @@
+import vcs
+from my_metrics import add
+from cdp.cdp_viewer import OutputViewer
+
+result = add(1, 1)
+
+# Using vcs to visualize the result. This is just to show the viewer.
+vcs_canvas = vcs.init(bg=True, geometry=(256, 256))
+text = vcs_canvas.createtextcombined()
+text.x = 0.5
+text.y = 0.5
+text.string = str(result)
+text.height = 96
+text.halign = 'center'
+vcs_canvas.plot(text)
+vcs_canvas.png('output.png')
+
+viewer = OutputViewer(index_name='My Cool Results')
+# 'My Results' is the title of the page in the index. 'Generated File' is the column for each group.
+viewer.add_page("My Results", ['Generated File'])
+viewer.add_group('Results of addition')
+viewer.add_row('Result of 1 + 1', file_name='output.png')
+viewer.add_row('Another Result', file_name='output.png')
+viewer.add_group('Results of sub')
+viewer.add_row('sub2', file_name='output.png')
+viewer.generate_viewer()

example/basic_driver.py

@@ -0,0 +1,5 @@
+import add
+import sub
+
+add = add.Add()
+sub = sub.Sub()

example/my_metrics/__init__.py

@@ -0,0 +1,5 @@
+import cdp.cdp_metric
+
+class Add(cdp.cdp_metric.CDPMetric):
+    def compute(self, a, b):
+        return a + b

example/my_metrics/add.py

@@ -0,0 +1,5 @@
+import cdp.cdp_metric
+
+class Sub(cdp.cdp_metric.CDPMetric):
+    def compute(self, a, b):
+        return a - b