Merge pull request #287 from jnsebgosselin/save_brf_to_csv

PR: Add an option to export BRF results to a csv or Excel file.

gwhat/brf_mod/kgs_gui.py

@@ -37,7 +37,8 @@
 
 import gwhat.common.widgets as myqt
 from gwhat.widgets.layout import VSep, HSep
-from gwhat.widgets.buttons import LangToolButton, OnOffToolButton
+from gwhat.widgets.buttons import (LangToolButton, OnOffToolButton,
+                                   ExportDataButton)
 from gwhat.common import StyleDB
 from gwhat.utils import icons
 from gwhat.utils.icons import QToolButtonNormal, QToolButtonSmall
@@ -386,7 +387,8 @@ def calc_brf(self):
             dataf = bm.read_brf_output()
             date_start, date_end = (xldate_as_datetime(xldate, 0) for
                                     xldate in self.get_brfperiod())
-            self.wldset.save_brf(dataf, date_start, date_end)
+            self.wldset.save_brf(dataf, date_start, date_end,
+                                 self.detrend_waterlevels)
             self.viewer.new_brf_added()
             self.viewer.show()
             QApplication.restoreOverrideCursor()
@@ -462,6 +464,10 @@ def __initGUI__(self):
         btn_save.setToolTip('Save current BRF graph as...')
         btn_save.clicked.connect(self.select_savefig_path)
 
+        self.btn_export = QToolButtonNormal(icons.get_icon('export_data'))
+        self.btn_export.setToolTip('Export data to file.')
+        self.btn_export.clicked.connect(self.select_export_brfdata_filepath)
+
         self.btn_copy = QToolButtonNormal('copy_clipboard')
         self.btn_copy.setToolTip('Copy figure to clipboard as image.')
         self.btn_copy.clicked.connect(self.copyfig_to_clipboard)
@@ -474,9 +480,10 @@ def __initGUI__(self):
 
         self.tbar = myqt.QFrameLayout()
 
-        buttons = [btn_save, self.btn_copy, self.btn_del,  self.btn_del_all,
-                   VSep(), self.btn_prev, self.current_brf, self.total_brf,
-                   self.btn_next, VSep(), self.btn_setp, self.btn_language]
+        buttons = [btn_save, self.btn_copy, self.btn_export, self.btn_del,
+                   self.btn_del_all, VSep(), self.btn_prev, self.current_brf,
+                   self.total_brf, self.btn_next, VSep(), self.btn_setp,
+                   self.btn_language]
 
         for btn in buttons:
             if isinstance(btn, QLayout):
@@ -618,8 +625,30 @@ def copyfig_to_clipboard(self):
         QApplication.clipboard().setImage(QImage.fromData(buf.getvalue()))
         buf.close()
 
-    # ---- Others
+    def select_export_brfdata_filepath(self):
+        """
+        Open a dialog to select a file path where to save the brf data.
+        """
+        fname = 'brf_' + self.wldset['Well']
+        if self.wldset['Well ID']:
+            fname += '_%s' % self.wldset['Well ID']
+        ddir = osp.join(self.__save_ddir, fname)
 
+        dialog = QFileDialog()
+        fname, ftype = dialog.getSaveFileName(
+                self, "Export Data", ddir, "*.xlsx;;*.xls;;*.csv")
+        ftype = ftype.replace('*', '')
+        if fname:
+            self.__save_ddir = osp.dirname(fname)
+            if not fname.endswith(ftype):
+                fname = fname + ftype
+            self.export_brf_data(fname)
+
+    def export_brf_data(self, fname):
+        """Export the current BRF data to to file."""
+        self.wldset.export_brf_to_csv(fname, self.current_brf.value()-1)
+
+    # ---- Others
     def set_wldset(self, wldset):
         self.wldset = wldset
         if wldset is None:
@@ -650,7 +679,7 @@ def plot_brf(self):
             xmax = self.graph_opt_panel.xmax
             xscale = self.graph_opt_panel.xscale
             time_units = self.graph_opt_panel.time_units
-   
+
             date0 = databrf.date_start.strftime(format='%d/%m/%y %H:%M')
             date1 = databrf.date_end.strftime(format='%d/%m/%y %H:%M')
             self.brf_canvas.figure.plot_BRF(

gwhat/projet/reader_projet.py

@@ -668,18 +668,25 @@ def get_brf(self, name):
                     datetime.datetime(*grp[key][...], 0).isoformat())
                 del grp[key]
                 flush = True
+        if 'detrending' not in grp.attrs.keys():
+            grp.attrs['detrending'] = ''
+            flush = True
         if flush:
             self.dset.file.flush()
 
         # Cast the data into a pandas dataframe.
-        dataf = pd.DataFrame({key: grp[key][...] for key in grp.keys()})
+        keys = ['Lag', 'A', 'sdA', 'SumA', 'sdSumA', 'B',
+                'sdB', 'SumB', 'sdSumB']
+        dataf = pd.DataFrame({key: grp[key][...] for key in keys})
         dataf.date_start = datetime.datetime.strptime(
             grp.attrs['date start'], "%Y-%m-%dT%H:%M:%S")
         dataf.date_end = datetime.datetime.strptime(
             grp.attrs['date end'], "%Y-%m-%dT%H:%M:%S")
+        dataf.detrending = grp.attrs['detrending']
+
         return dataf
 
-    def save_brf(self, dataf, date_start, date_end):
+    def save_brf(self, dataf, date_start, date_end, detrending=None):
         """
         Save the BRF results.
         """
@@ -699,6 +706,8 @@ def save_brf(self, dataf, date_start, date_end):
                 column, data=dataf[column].values, dtype='float64')
         grp.attrs['date start'] = date_start.isoformat()
         grp.attrs['date end'] = date_end.isoformat()
+        grp.attrs['detrending'] = {
+            True: 'Yes', False: 'No', None: ''}[detrending]
 
         self.dset.file.flush()
         print('done')
@@ -712,8 +721,38 @@ def del_brf(self, name):
         else:
             print('BRF does not exist')
 
-    # ---- Hydrograph layout
+    def export_brf_to_csv(self, filename, index):
+        """
+        Export the BRF results saved at the specified index in a CSV or
+        Excel file.
+        """
+        databrf = self.get_brf(self.get_brfname_at(index))
+        databrf.insert(0, 'LagNo', databrf.index.astype(int))
+
+        fcontent = [
+            ['Well Name :', self['Well']],
+            ['Well ID :', self['Well ID']],
+            ['Latitude :', self['Latitude']],
+            ['Longitude :', self['Longitude']],
+            ['Elevation :', self['Elevation']],
+            ['Municipality :', self['Municipality']],
+            ['Province :', self['Province']],
+            [],
+            ['BRF Start Time :',
+             databrf.date_start.strftime(format='%d/%m/%y %H:%M')],
+            ['BRF End Time :',
+             databrf.date_end.strftime(format='%d/%m/%y %H:%M')],
+            ['Number of BP Lags :', len(databrf['A']) - 1],
+            ['Number of ET Lags :',
+             len(databrf['B'].dropna(inplace=False)) - 1],
+            ['Developed with detrending :', databrf.detrending],
+            []]
+        fcontent.append(list(databrf.columns))
+        fcontent.extend(nan_as_text_tolist(databrf.values))
 
+        save_content_to_file(filename, fcontent)
+
+    # ---- Hydrograph layout
     def save_layout(self, layout):
         """Save the layout in the project hdf5 file."""
         grp = self.dset['layout']
@@ -907,7 +946,10 @@ def load_dict_from_h5grp(h5grp):
 
     data = WLDSET.data
 
-    # GLUEDF = WLDSET.get_glue('1')
+    WLDSET.brf_count()
+
+    filename = 'C:/Users/User/Desktop/brf_test.csv'
+    WLDSET.export_brf_to_csv(filename, 0)
     # glue_count = GLUEDF['count']
     # dly_glue = GLUEDF['daily budget']