las2witsml 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa4fc245989bfce59ebfbd113ae2d834e5770823
-  data.tar.gz: e5f278bba13a39d059bd3fffff47b64b8b8f86cf
+  metadata.gz: 14c9e773b85635719360a9154e63d2d9aacd7422
+  data.tar.gz: 4bb54334c6d22e09314bb79fd5943337c7229cc7
 SHA512:
-  metadata.gz: 7b3ee9d49069145a5da173ba8853f7813e6f3f34946973ec060d743f799c92e4ecd0b6cdeaf51f047423f09372dbb43dc2cd936a2486926db003ad73a662f171
-  data.tar.gz: abea5c4ebc9eb65f006fbe4f47998e68fdd56c8fd211af35d4543582c45eeabeef3c7701b406026c27f3133cbc4596921fd0ffcdd63086d202284ef3534c3a20
+  metadata.gz: 57254ea3787533afd554409b84af521649f466d37e0aa88b45595e582e2878821f9e2f5cd321592438ad8d88c14612f58f331fa6933a4a2ce120c13814f2e4cb
+  data.tar.gz: 4711d47f0e9657677421a4c00815bc7819eead4aefbfbcfe83ba6656280121fb56de13aea36fb15152a2bbb7e3093e34c3b15a28830b04de08b91d94048cc0e8

data/README

@@ -1,14 +1,16 @@
-las2witsml -- Convert Log ASCII Stanfard (LAS) files to WITSML <log> objects.
+las2witsml -- Convert Log ASCII Standard (LAS) files to WITSML <log> objects.
 
 Use this script to convert LAS files to WITSML logs. The script attempts to be forgiving
 of some commonly encountered variations. It can process most LAS v2 and v3 files.  
 
-Usage: las2witsml [-n name] [-u uid] [-b uid] [-l uid] [-x version] [-h] [-v] lasfile
+Usage: las2witsml [-n name] [-u uid] [-b uid] [-l uid] [-x version] [-m uomfile] [-h] [-v] lasfile
     -n, --namelog name               Name to give the WITSML log; default 'Untitled'
     -u, --uidwell uid                WITSML uid of the containing well
     -b, --uidwellbore uid            WITSML uid of the containing wellbore
     -l, --uidlog  uid                WITSML uid to assign the log
     -x, --version  version           WITSML version to emit, either 1.3.1 or 1.4.1; default 1.4.1
+    -m, --uomfile  path              Path to a units of measure JSON file, mapping foreign  
+                                     to WITSML units of measure e.g. https://github.com/wellstorm/las2witsml/blob/master/lib/uom.json 
     -v, --verbose                    Emit diagnostic output on stderr
     -h, --help                       Show this message
 
@@ -22,4 +24,6 @@ History:
 
 12 Jun 2012 -- gemified existing code and initial commit. (0.1.1)
 14 Jun 2012 -- proper return values to shell: 0 success, 1 failure. (0.1.2)
-
+30 Sep 2013 -- extended list of units of measure; throw exception if unrecognized uom. (0.1.3)
+ 1 Oct 2013 -- support for external uom file (0.1.4)
+ 4 Oct 2013 -- report all the uom conversion errors if there are any. (0.1.5)

data/bin/las2witsml

@@ -65,7 +65,7 @@ if ( !options[:url] )
   #exit 1
 end
 
-
+succeed = false
 ARGV.each do|a|
   l2w = Las2Witsml.new
   infile = File.new a, 'r'
@@ -79,12 +79,17 @@ ARGV.each do|a|
   end
   begin  
     succeed = l2w.run infile, outfile, options[:uw] || "",  options[:uwb] || "",  options[:ul] || "", options[:name] || 'Untitled', version, options[:v] != false, options[:uom_file]
-    succeed ? 0 : 1
   rescue => e
-    $stderr.puts e.backtrace
-    1
+    $stderr.puts e
+    exit 1
   end
 end
 
+if succeed 
+  exit 0
+else
+  exit 1
+end
+
 
 

data/lib/las2witsml.rb

@@ -18,6 +18,9 @@ class Las2Witsml
     rescue => e
       $stderr.puts e.backtrace.join("\n")
       false
+    rescue  WitsmlFile::ConversionError => e
+      $stderr.puts e.message
+      false
     end
   end
 end

data/lib/las_file.rb

@@ -16,13 +16,30 @@ class LasFile
   :start_measured_depth_index, :stop_measured_depth_index, 
   :start_date_time_index, :stop_date_time_index,
   :null_value, :service_company, :curve_values,
-  :elevation_kelly_bushing, :log_measured_from, :permanent_datum, :above_permanent_datum
+  :elevation_kelly_bushing, :log_measured_from, :permanent_datum, :above_permanent_datum,
+  :elevation_permanent_datum
     
   def initialize(io)
     @log_curve_infos = []
     @curve_values = []
     @in = io
     @next_line=nil
+
+    @measured_depth_unit =nil
+    @start_measured_depth_index=nil
+    @stop_measured_depth_index=nil
+    @start_date_time_index=nil
+    @stop_date_time_index=nil
+    @null_value=nil
+    @service_company=nil
+    @curve_values=nil
+    @elevation_kelly_bushing=nil
+    @log_measured_from=nil
+    @permanent_datum=nil
+    @above_permanent_datum=nil
+    @elevation_permanent_datum = nil
+    
+
   end
   
   def process verbose=false

data/lib/witsml_file.rb

@@ -6,7 +6,15 @@ require 'uom'
 class WitsmlFile
   class UnrecognizedUnitException < Exception
   end
-  
+
+  class ConversionError < Exception
+    attr_accessor :bad_units
+    def initialize bad_units
+      super "Units conversion problems: #{bad_units}"
+      @bad_units = bad_units
+    end
+  end
+
   def initialize(out, witsml_version = 1410, uom_file = nil)
     @indent = 0
     @out = out
@@ -51,7 +59,7 @@ class WitsmlFile
       get_index = lambda do |values|
         date = values[date_index]
         #$stderr.puts "date #{date} fmt = #{date_fmt}"
-       
+        
         if date_fmt == '1' then
           #$stderr.puts "date = #{date}"
           offset = las_file.start_date_time_index
@@ -74,15 +82,19 @@ class WitsmlFile
     end
     [new_lcis, index_lci, is_index_index, get_index]
   end
- 
- 
+  
+  
   def not_empty s
     s && s.length > 0
   end
   
+  # Populate the WITSML log from a LAS file.
+  # Return nil on success.
+  # Raise a ConversionError exception containing a problem description on failure.
+  
   def from_las_file(las_file, uid_well='$UIDWELL', uid_wellbore='$UIDWELLBORE', uid='$UID', name='$NAME', verbose=false)
     new_lcis, _, is_index_index, get_index = digest_las(las_file)  #unused index_lci
- 
+    
     if @witsml_version >= 1410
       ns = 'http://www.witsml.org/schemas/1series'
       vers = '1.4.1.0'
@@ -91,6 +103,9 @@ class WitsmlFile
       vers = '1.3.1.1'
     end
     
+    # Accumulate bad unit references in an array
+    bad_units = []
+
     index_curve = new_lcis[0].mnemonic  # assume first column is index
     add_element('logs',{'xmlns'=>ns, 'version'=>vers}) do
       add_element('log', {'uidWell' => uid_well, 'uidWellbore'=>uid_wellbore, 'uid' => uid}) do
@@ -101,16 +116,20 @@ class WitsmlFile
         add_text_element  'serviceCompany', las_file.service_company if not_empty(las_file.service_company)
         add_text_element  'description', 'Created by Wellstorm LAS Import'
 
-        measured_depth_unit = normalize_unit(las_file.measured_depth_unit);
-      
+        begin
+          measured_depth_unit = normalize_unit(las_file.measured_depth_unit);
+        rescue UnrecognizedUnitException => e
+          # record the error, set a default value for unit, and continue
+          bad_units.push( {:name => 'measured depth', :unit => e.message})
+          measured_depth_unit = 'unitless'
+        end
+
         if measured_depth_unit then
           add_text_element  'indexType', 'measured depth'
           add_text_element  'startIndex', las_file.start_measured_depth_index, {'uom' => measured_depth_unit} if las_file.start_measured_depth_index
           add_text_element  'endIndex', las_file.stop_measured_depth_index, {'uom' => measured_depth_unit} if las_file.stop_measured_depth_index        
         else
           add_text_element  'indexType', 'date time'
-
-
           #puts ("start index in LAS is #{las_file.start_date_time_index}")
 
           add_text_element  'startDateTimeIndex', las_file.start_date_time_index.iso8601 if las_file.start_date_time_index
@@ -118,14 +137,14 @@ class WitsmlFile
         end 
         #add_text_element  'direction' 
         
-        if @witsml_version >= 1410
+        if @witsml_version >= 1410 then
           add_text_element  'indexCurve', index_curve
         else
           add_text_element  'indexCurve', index_curve, {'columnIndex'=>1}
         end
         add_text_element  'nullValue', las_file.null_value
 
-       
+        
         begin
           # use this new array of curve values we build
           tempfile = Tempfile.new 'las2witsml'
@@ -140,53 +159,65 @@ class WitsmlFile
             tempfile << idx
             #$stderr.puts "idx #{idx}"
             values.each_with_index do |v, i|
-            
+
               start[i] = idx if start[i].nil? and v != las_file.null_value
               stop[i] = idx if v != las_file.null_value
               tempfile << ",#{v}" if  !is_index_index.call(i) 
 
-             # $stderr.puts "put #{v} on tempfile"
+              # $stderr.puts "put #{v} on tempfile"
             end
             tempfile << $/
             nil
           end
           $stderr.puts "done adding lines to tempfile" if verbose   
- 
+          
           tempfile.rewind 
 
           $stderr.puts "rewound #{tempfile}" if verbose
- 
+          
           # Now we can build the lcis, surveying each curve for its min/max indexes
           new_lcis.each_with_index do |lci, index|
-            add_log_curve_info lci, (index + 1), start[index+1],  stop[index+1], measured_depth_unit
+            begin
+              add_log_curve_info lci, (index + 1), start[index+1],  stop[index+1], measured_depth_unit
+            rescue UnrecognizedUnitException => e
+              bad_units.push( {:name => lci.mnemonic, :unit => e.message})          
+            end
           end
 
           $stderr.puts "added #{new_lcis.length} LCIs" if verbose   
-        
+          
           
           # Now add the curve data
-          add_element 'logData' do
-            if @witsml_version >= 1410
-              add_text_element 'mnemonicList', new_lcis.map{|lci| lci.mnemonic}.join(',')
-              add_text_element 'unitList', new_lcis.map{|lci| lci.unit}.join(',')              
-            end 
+          if bad_units.length == 0 then 
+            add_element 'logData' do
+              if @witsml_version >= 1410
+                add_text_element 'mnemonicList', new_lcis.map{|lci| lci.mnemonic}.join(',')
+                add_text_element 'unitList', new_lcis.map{|lci| lci.unit}.join(',')              
+              end 
 
-            n = 0
-            tempfile.each_line do |values|
-              add_text_element 'data', values
-              n = n + 1
-              $stderr.puts "converted #{n} lines to WITSML" if (verbose && n % 1000 == 0 )
+              n = 0
+              tempfile.each_line do |values|
+                add_text_element 'data', values
+                n = n + 1
+                $stderr.puts "converted #{n} lines to WITSML" if (verbose && n % 1000 == 0 )
+              end
+              $stderr.puts "converted a total of #{n} lines to WITSML" if verbose
             end
-            $stderr.puts "converted a total of #{n} lines to WITSML" if verbose
           end
-        rescue
+        ensure
           tempfile.close true
         end
-
       end
     end
+    #return nil if all succeeded, or a problem hash if not
+    if bad_units.length == 0
+      return nil
+    else
+      e = ConversionError.new bad_units
+      raise e
+    end
   end
-  
+    
   private
   def add_element name, attrs = {}, one_liner = false
     @indent.times {@out.write " "}
@@ -244,7 +275,7 @@ class WitsmlFile
 
 
   def make_time_indexes(lcis) 
- 
+    
     # Typically we see DATE and TIME
     # We can also see only TIME in which case we expect long integer seconds since 1970
     # (There's no spec that says that; but this data comes from SLB's IDEAL which uses Unix epoch)
@@ -256,7 +287,7 @@ class WitsmlFile
     
     $stderr.puts("date_index #{date_index}, time_index #{time_index}")    
 
- 
+    
     if !time_index then
       #assume time will be in the next column
       time_index = (date_index + 1) if date_index
@@ -277,7 +308,7 @@ class WitsmlFile
     raise "No TIME or DATE" if (!time_index && !date_index)
     
     [date_index, time_index, date_fmt]
-          
+    
   end
 
   def normalize_unit(las_unit)
@@ -287,15 +318,15 @@ class WitsmlFile
 
     return las_unit if !las_unit
 
-# just a few random ones from CWLS web site:
-# RHOB  .K/M3       45 350 02 00 :  2       BULK DENSITY
-#NPHI  .VOL/VO     42 890 00 00 :  3       NEUTRON POROSITY - SANDSTONE
-#MSFL  .OHMM       20 270 01 00 :  4       Rxo RESISTIVITY
-# SP    .MV         07 010 01 00 :  8       SPONTANEOUS POTENTIAL
-#GR    .GAPI       45 310 01 00 :  9       GAMMA RAY
-#CALI  .MM         45 280 01 00 :  10      CALIPER
-#DRHO .K/M3        45 356 01 00 :  11      DENSITY CORRECTION
- 
+    # just a few random ones from CWLS web site:
+    # RHOB  .K/M3       45 350 02 00 :  2       BULK DENSITY
+    #NPHI  .VOL/VO     42 890 00 00 :  3       NEUTRON POROSITY - SANDSTONE
+    #MSFL  .OHMM       20 270 01 00 :  4       Rxo RESISTIVITY
+    # SP    .MV         07 010 01 00 :  8       SPONTANEOUS POTENTIAL
+    #GR    .GAPI       45 310 01 00 :  9       GAMMA RAY
+    #CALI  .MM         45 280 01 00 :  10      CALIPER
+    #DRHO .K/M3        45 356 01 00 :  11      DENSITY CORRECTION
+    
     retval = @uom.translate las_unit
     if !retval 
       raise UnrecognizedUnitException, las_unit 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: las2witsml
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Hugh Winkler