las_reader 0.0.3 → 0.0.4

data/README.md

@@ -1,11 +1,10 @@
 # LasReader
 
-cwls-las-reader
 Ruby gem for reading CWLS LAS files
 
-The Canadian Well Logging Society's Floppy Disk Committee has designed a standard format for log data on floppy disks. It is known as the LAS format (Log ASCII Standard). LAS consists of files written in ASCII containing minimal header information and is intended for optical curves only.
+The Log ASCII Standard was created by the Canadian Well Logging Society in the late 1980’s. LAS was intended to supply basic digital log data to users of personal computers in a format that was quick and easy to use. LAS is an ASCII file with minimal header information, intended for optically presented log curves.  The world-wide acceptance of LAS proved the need for such a format. As users embraced the concept and the format, many new applications of the concept were attempted. Right now the latest version of the LAS format is 3.0. 
 
-Details of the LAS format are described in this paper (http://www.cwls.org/docs/LAS12_Standards.txt).
+This gem does not read LAS 3.0 format yet because its initial intent is to be used in E&P data management applications.  Version 3.0 was released in June 10, 2000 so most of the data I have access right now is either in 1.2 or 2.0 format. 
 
 ## Installation
 
@@ -21,11 +20,50 @@ Or install it yourself as:
 
     $ gem install las_reader
 
-## Quick irb Usage
+## Quick Usage
     
-    irb> require 'rubygems'
-    irb> require 'las_reader'
-    irb> my_las = CWLSLas.new('my_well.las')
+    require 'rubygems'
+    require 'las_reader'
+    my_las = CWLSLas.new('my_well.las')
+
+## Usage
+
+One of the main fucntionalities of the las_reader is to provide a way to access the curves inside the LAS file and other information regarding the well and about the logged data. Bellow an example of how to get the curve "DEEP RESISTIVITY" from the file [example1.las](https://github.com/gpcarmo/cwls-las-reader/blob/master/spec/fixtures/files/example1.las). You can find this example files inside [spec/fixtures/files](https://github.com/gpcarmo/cwls-las-reader/tree/master/spec/fixtures/files) folder.
+
+### Examples
+
+To begin the showing the basic examples, lets start a new CWLSLas object with a file name of an example las. Then we can get the well name:
+
+     my_las = CWLSLas.new('example1.las')
+     my_las.well_name
+ 
+    => "ANY ET AL OIL WELL #12"
+    
+
+To get the curve mnemonics inside the file:
+
+    my_las.curve_names
+    
+    => ["ILD", "ILM", "DT", "NPHI", "RHOB", "SFLA", "SFLU", "DEPT"] 
+
+and to get a specific curve use:
+
+    ild_curve = my_las.curve('ILD')
+
+
+From this new curve object you may want to get the description:
+
+    ild_curve.description
+
+    => "8  DEEP RESISTIVITY"
+
+Or, the values of the curve:
+
+    ild_curve.log_data
+    
+    => [105.6, 105.6, 105.6]
+
+
 
 ## Contributing
 

data/lib/las_reader.rb

@@ -13,9 +13,9 @@ module LasReader
   attr_reader :well_info
 
   def set_version(info)
-    version = info.match(/(VERS\.).+([1-3]\.[0-9]).*:\s*(.*)/)
+    version = info.match(/(VERS\s*\.).+([1-3]\.[0-9]).*:\s*(.*)/)
     if version.nil?
-      wrap_mode = info.match(/(WRAP\.).+(YES|NO).*:\s*(.*)/)
+      wrap_mode = info.match(/(WRAP\s*\.).+(YES|NO).*:\s*(.*)/)
       if not wrap_mode.nil?
           @wrap =  (wrap_mode[2] == "YES") ? true : false
       end
@@ -26,7 +26,7 @@ module LasReader
   end
 
   def set_curve_info(info)
-    mnemonic = info.match(/(\w+)\s*\.(\S*)\s+(.*):\s*(.*)/)
+    mnemonic = info.match(/(\w+)\s*\.(\S*)\s+(.*):\s*(.*)$/)
     unless mnemonic.nil?
       @curves["#{mnemonic[1]}"] = Curve.new(mnemonic[1],mnemonic[2],mnemonic[3],mnemonic[4])
       @acurves << mnemonic[1]
@@ -34,14 +34,13 @@ module LasReader
   end
 
   def set_parameters(info)
-    mnemonic = info.match(/(\w+)\s*\.(\S+)\s+(.*):\s*(.*)/)
+    mnemonic = info.match(/(\w+)\s*\.(\S+)\s+(.*):\s*(.*)$/)
     unless mnemonic.nil?
       @parameters["#{mnemonic[1]}"] = Mnemonic.new(mnemonic[1],mnemonic[2],mnemonic[3],mnemonic[4])
     end
   end
 
   def set_well_info(info)
-
     strt = info.match(/(STRT)\s*\.(\w).+\s([0-9]+\.[0-9]+).*:\s*(.*)/)
     unless strt.nil?
       @well_info.start_depth = strt[3].to_f
@@ -67,67 +66,67 @@ module LasReader
       return
     end
 
-    comp = info.match(/(COMP\s*\..+COMPANY:\s*(.*))|(COMP\s*\.\s*(.*)\s+:COMPANY)/)
+    comp = info.match(/(COMP\s*\..+COMPANY:\s*(.*))|(COMP\s*\.\s*(.*)\s+:\s*COMPANY)/)
     unless comp.nil?
       @well_info.company_name = (comp[2] or comp[4]).strip
       return
     end
 
-    well = info.match(/(WELL\s*\..+WELL:\s*(.*))|(WELL\s*\.\s*(.*)\s+:WELL)/)
+    well = info.match(/(WELL\s*\..+WELL:\s*(.*))|(WELL\s*\.\s*(.*)\s+:\s*WELL)/)
     unless well.nil?
       @well_info.well_name = (well[2] or well[4]).strip
       return
     end
 
-    fld = info.match(/(FLD\s*\..+FIELD:\s*(.*))|(FLD\s*\.\s*(.*)\s+:FIELD)/)
+    fld = info.match(/(FLD\s*\..+FIELD:\s*(.*))|(FLD\s*\.\s*(.*)\s+:\s*FIELD)/)
     unless fld.nil?
       @well_info.field_name = (fld[2] or fld[4]).strip
       return
     end
 
-    loc = info.match(/(LOC\s*\..+LOCATION:\s*(.*))|(LOC\s*\.\s*(.*)\s+:LOCATION)/)
+    loc = info.match(/(LOC\s*\..+LOCATION:\s*(.*))|(LOC\s*\.\s*(.*)\s+:\s*LOCATION)/)
     unless loc.nil?
       @well_info.location = (loc[2] or loc[4]).strip
       return
     end
 
-    prov = info.match(/(PROV\s*\..+PROVINCE:\s*(.*))|(PROV\s*\.\s*(.*)\s+:PROVINCE)/)
+    prov = info.match(/(PROV\s*\..+PROVINCE:\s*(.*))|(PROV\s*\.\s*(.*)\s+:\s*PROVINCE)/)
     unless prov.nil?
       @well_info.province = (prov[2] or prov[4]).strip
       return
     end
 
-    cnty = info.match(/(CNTY\s*\..+COUNTY:\s*(.*))|(CNTY\s*\.\s*(.*)\s+:COUNTY)/)
+    cnty = info.match(/(CNTY\s*\..+COUNTY:\s*(.*))|(CNTY\s*\.\s*(.*)\s+:\s*COUNTY)/)
     unless cnty.nil?
       @well_info.county = (cnty[2] or cnty[4]).strip
       return
     end
 
-    stat = info.match(/(STAT\s*\..+STATE:\s*(.*))|(STAT\s*\.\s*(.*)\s+:STATE)/)
+    stat = info.match(/(STAT\s*\..+STATE:\s*(.*))|(STAT\s*\.\s*(.*)\s+:\s*STATE)/)
     unless stat.nil?
       @well_info.state = (stat[2] or stat[4]).strip
       return
     end
 
-    ctry  = info.match(/(CTRY\s*\..+COUNTRY:\s*(.*))|(CTRY\s*\.\s*(.*)\s+:COUNTRY)/)
+    ctry  = info.match(/(CTRY\s*\..+COUNTRY:\s*(.*))|(CTRY\s*\.\s*(.*)\s+:\s*COUNTRY)/)
     unless ctry.nil?
       @well_info.country = (ctry[2] or ctry[4]).strip
       return
     end
 
-    srvc = info.match(/(SRVC\s*\..+SERVICE COMPANY:\s*(.*))|(SRVC\s*\.\s*(.*)\s+:SERVICE COMPANY)/)
+    srvc = info.match(/(SRVC\s*\..+SERVICE COMPANY:\s*(.*))|(SRVC\s*\.\s*(.*)\s+:\s*SERVICE COMPANY)/)
     unless srvc.nil?
       @well_info.service_company = (srvc[2] or srvc[4]).strip
       return
     end
 
-    data = info.match(/(DATE\s*\..+LOG DATE:\s*(.*))|(DATE\s*\.\s*(.*)\s+:LOG DATE)/)
+    data = info.match(/(DATE\s*\..+LOG DATE:\s*(.*))|(DATE\s*\.\s*(.*)\s+:\s*LOG DATE)/)
     unless data.nil?
       @well_info.date_logged = (data[2] or data[4]).strip
       return
     end
 
-    uwi = info.match(/(UWI\s*\..+UNIQUE WELL ID:\s*(.*))|(UWI\s*\.\s*(.*)\s+:UNIQUE WELL ID)/)
+    uwi = info.match(/(UWI\s*\..+UNIQUE WELL ID:\s*(.*))|(UWI\s*\.\s*(.*)\s+:\s*UNIQUE WELL ID)/)
     unless uwi.nil?
       @well_info.uwi = (uwi[2] or uwi[4]).strip
       return
@@ -227,46 +226,147 @@ class CWLSLas
 
   include LasReader
 
+  # Initialize CWLSLas object passing las file as argument
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #
+  # Arguments:
+  #   las_file_name: (String)
+
   def initialize(filename=nil)
     load_file(filename) if not filename.nil?
   end
 
+  # Return a list of mnemonics representing the curve names
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.curve_names
+  #   => ["ILD", "ILM", "DT", "NPHI", "RHOB", "SFLA", "SFLU", "DEPT"]
+  #
+
   def curve_names
     self.curves.keys
   end
 
+  # Returns an object representing the curve selected
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.curve('ILD')
+  #   => #<LasReader::Curve:0x7f @description="DEEP RESISTIVITY", @unit="OHMM", @name="ILD", @log_data=[105.6, 105.6, 105.6]>
+  #
+  # Arguments:
+  #   curve mnemonic: (String)
+
   def curve(curve_name)
     self.curves[curve_name]
   end
 
+  # Return a list of mnemonics representing the curve names
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.well_name
+  #   => "ANY ET AL OIL WELL #12"
+  #
+
   def well_name
     self.well_info.well_name
   end
 
+  # Returns the company name tha owns the well
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.company_name
+  #   => "ANY OIL COMPANY LTD."
+  #
+
   def company_name
     self.well_info.company_name
   end
 
+  # Returns the field name described in the file
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.field_name
+  #   => "CAMPOS"
+  #
+
   def field_name
     self.well_info.field_name
   end
 
+  # Returns the location described in the file 
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.location
+  #   => "-43.173871636390686 -22.964858960678484"
+  #
+
   def location
     self.well_info.location
   end
  
+  # Returns the province described in the file 
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.province
+  #   => "RIO DE JANEIRO"
+  #
+
   def province
     self.well_info.province
   end
 
+  # Returns the service company that performed the log acquisition 
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.service_company
+  #   => "ANY LOGGING COMPANY LTD."
+  #
+
   def service_company
     self.well_info.service_company
   end
 
+  # Returns a String with the date described in the file.
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.log_date
+  #   => "25-DEC-1988"
+  #
+
   def log_date
     self.well_info.date_logged
   end
 
+  # Returns the UWI (UNIQUE WELL ID) described in the file 
+  # 
+  # Example:
+  #   >> my_well = CWLSLas.new('my_well.las')
+  #   => #<CWLSLas>
+  #   >> my_well.uwi
+  #   => "100091604920W300"
+  #
+
   def uwi
     self.well_info.uwi
   end

data/lib/las_reader/version.rb

@@ -1,3 +1,3 @@
 module LasReader
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/fixtures/files/example21.las

@@ -5,18 +5,18 @@
 ~WELL INFORMATION 
 #MNEM.UNIT              DATA                       DESCRIPTION
 #----- -----            ----------               -------------------------
-STRT    .M              1670.0000                :START DEPTH
-STOP    .M              1660.0000                :STOP DEPTH
-STEP    .M              -0.1250                  :STEP 
-NULL    .               -999.25                  :NULL VALUE
-COMP    .       ANY OIL COMPANY INC.             :COMPANY
-WELL    .       ANY ET AL 12-34-12-34            :WELL
-FLD     .       WILDCAT                          :FIELD
-LOC     .       12-34-12-34W5M                   :LOCATION
-PROV    .       ALBERTA                          :PROVINCE 
-SRVC    .       ANY LOGGING COMPANY INC.         :SERVICE COMPANY
-DATE    .       13-DEC-86                        :LOG DATE
-UWI     .       100123401234W500                 :UNIQUE WELL ID
+STRT    .M              1670.0000                : START DEPTH
+STOP    .M              1660.0000                : STOP DEPTH
+STEP    .M              -0.1250                  : STEP 
+NULL    .               -999.25                  : NULL VALUE
+COMP    .       ANY OIL COMPANY INC.             : COMPANY
+WELL    .       ANY ET AL 12-34-12-34            : WELL
+FLD     .       WILDCAT                          : FIELD
+LOC     .       12-34-12-34W5M                   : LOCATION
+PROV    .       ALBERTA                          : PROVINCE 
+SRVC    .       ANY LOGGING COMPANY INC.         : SERVICE COMPANY
+DATE    .       13-DEC-86                        : LOG DATE
+UWI     .       100123401234W500                 : UNIQUE WELL ID
 ~CURVE INFORMATION
 #MNEM.UNIT              API CODES                   CURVE DESCRIPTION
 #------------------     ------------              -------------------------

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: las_reader
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Gilberto P. Carmo Jr.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-08 00:00:00 Z
+date: 2013-01-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec