Override Write

Override LASFile write to use version 2, no wrapping by default. This helps with code flow when using the Log class.

Also removed write function from viewer. Log object can be referenced from LogViewer.log and saved with method from log object.

Author: toddheitmann

petropy/graphs.py

@@ -630,12 +630,8 @@ def show(self):
         >>> log = ptr.log_data('WFMP') # sample Wolfcamp log
         >>> viewer = ptr.LogViewer(log, edit_mode = True) # allow edits when viewing
         >>> viewer.show() # display graphs with editing option
-        >>> viewer.write('wfmp_updated.las') # writes changed data to new las file
-
-        See Also
-        --------
-        write
-            LogViewer method to write the updated log to a new las file.
+        >>> s = 'path/to/new_file.las'
+        >>> viewer.log.write(f) # writes changed data to new las file
 
         """
         if self.edit_mode:
@@ -667,38 +663,6 @@ def show(self):
 
         plt.show()
 
-    def write(self, file_object, version = None, wrap = None, STRT = None, STOP = None, STEP = None, fmt = '%10.5g'):
-        """
-        Writes log stored in viewer to file.
-
-        Parameters
-        ----------
-        file_object : file
-            a file_like object opening for writing.
-        version : float (default None)
-            las version either 1.2 or 2
-        wrap : bool
-            Boolean to write a wrapped las file. If not provided, will default to WRAP item in Log object
-        STRT : float
-            Optional override to automatic calculation using the first index curve value.
-        STEP :  float
-            Optional override to automatic calculation using the first step size in the index curve.
-        fmt : str
-            Format string for numerical data being written to data section.
-
-        Example
-        -------
-        >>> import petropy as ptr
-        >>> log = ptr.log_data('WFMP') # sample Wolfcamp log
-        >>> viewer = ptr.LogViewer(log, edit_mode = True) # allow edits when viewing
-        >>> viewer.show() # display and graphically edit log
-        >>> with open('new_file.las', 'w') as f:
-        ...     viewer.write('new_file_name.las') # save edits to new las file
-
-        """
-
-        self.log.write(file_object, version = None, wrap = None, STRT = None, STOP = None, STEP = None, fmt = '%10.5g')
-
     def _curve_pick(self, event):
         """
         Event handler for selecting a curve to edit. Results in self._edit_curve being set to matplotlib

petropy/log.py

@@ -117,7 +117,7 @@ def tops_from_csv(self, csv_path = None):
         >>> log.tops_from_csv() # loads default tops for included datasets
 
         >>> import petropy as ptr
-        >>> log = ptr.Las('path/to/well.las') # loads specified las file
+        >>> log = ptr.Log('path/to/well.las') # loads specified las file
         >>> log.tops_from_csv('path/to/tops.csv') # loads specified tops csv
 
         """
@@ -1734,7 +1734,6 @@ def formation_multimineral_model(self, formations = [], parameter = 'default'):
         Examples
         --------
         >>> import petropy as ptr
-        >>> from petropy import datasets
         >>> log = ptr.log_data('WFMP') # reads sample Wolfcamp Log from las file
         >>> f = ['WFMPA', 'WFMPB', 'WFMPC']
         >>> # calculates fluid properties for formations WFMPA, WFMPB, and WFMPC with default settings
@@ -2122,3 +2121,38 @@ def to_csv(self, *args, **kwargs):
         df = self.df()
         df.fillna(value = self.well['NULL'].value, inplace = True)
         df.to_csv(*args, **kwargs)
+
+    def write(self, file_path, version = 2.0, wrap = False, STRT = None, STOP = None, STEP = None, fmt = '%10.5g'):
+        """
+        Writes to las file, and overwrites if file exisits. Uses parent class LASFile.write method
+        with specified defaults
+
+        Paramters
+        ---------
+        file_path : str
+            path to new las file.
+        version : {1.2 or 2} (default 2)
+            Version for las file
+        wrap : {True, Flase, None} (default False)
+            Specify to wrap data. If None, uses setting from when file was read.
+        STRT : float (default None)
+            Optional override to automatic calculation using the first index curve value.
+        STOP : float (default None)
+            Optional override to automatic calculation using the last index curve value.
+        STEP : float (default None)
+            Optional override to automatic calculation using the first step size in the index curve.
+        fmt : str (default '%10.5g')
+            Format string for numerical data being written to data section.
+
+        Example
+        -------
+        >>> import petropy as ptr
+        >>> log = ptr.log_data('WFMP') # reads sample Wolfcamp Log from las file
+        >>> p = 'path/to/new_file.las' # create file path to save log
+        >>> log.write(p)
+
+        """
+
+        with open(file_path, 'w') as f:
+            super(Log, self).write(f, version = version, wrap = wrap,
+                        STRT = STRT, STOP = STOP, STEP = None, fmt = fmt)