3D UTAPWeLS Scripting Manual

Transcription

1 3D UTAPWeLS Scripting Manual Contents Introduction... 2 Installing Matlab Based 3D UTAPWeLS... 2 Starting Maltab Based 3D UTAPWeLS... 2 Back Structure... 3 CSF... 4 Well... 5 Earth Model... 5 Log Set... 8 Log... 8 Nuclear Simulator... 8 Resistivity Simulator... 9 Examples Resistivity Simulation... 11

2 Introduction When 3D UTAPWeLS is open using the Matlab Based version you get access to the back of the software. This means that from the Matlab command window, you can manipulate your data freely, perform arbitrary calculations, use all of Matlab data visualization libraries, perform predefined 3D UTAPWeLS calculations, manipulate your earth models, and run simulations on them. Installing Matlab Based 3D UTAPWeLS First and foremost, make sure you have Matlab installed in your computer. We strongly recomm the specific version 2015b; newer versions might work too. Once you receive a zipped file from the 3D UTAPWeLS support group (utapwels@austin.utexas.edu): 1. Unzip the zipped files UTAPWeLS_MB_X.XX.zip to a temporary directory. 2. Double-click on the startinstaller.bat file to open the installation wizard. 3. The installation wizard will ask you to choose an installation folder (please make sure you have permissions to it), and will inquire whether you want to create a desktop shortcut. 4. Continue with the wizard instructions to complete the installation. Starting Maltab Based 3D UTAPWeLS If you chose to create a desktop shortcut for the Matlab Based version of 3D UTAPWeLS, you can just double click on it, and Matlab will open with the a CSF 1 object called utapcsf loaded. This is your back entry point. Otherwise you can open Matlab (2015b) and type: sessionobject = UTAPWeLS ; this will start the program. To reach the back entry point, now type: utapcsf = sessionobject.sessiondata. 1 Common Stratigraphic Framework

3 If you switch projects, you have switched your CSF object, so you need to get it again from the UTAPWeLS session object. That is done simply by typing utapcsf = sessionobject.sessiondata, assuming you did not assign the variable name sessionobject to anything else. Back Structure Besides the CSF object, the main objects used across 3D UTAPWeLS back are: Wells, Surfaces, Trajectories, Earth Models, Simulators (Resistivity, Nuclear, NMR, Sonic, Fluid Flow), and Calculators (Bulk Nuclear Properties, Resistivity, etc.). In this section we detail the main properties, and methods of each. See Figure 1 for a conceptual map of the data organization. Figure 1: 3D UTAPWeLS back data organization

4 It is also worth pointing out that the available properties and methods can always be found by using Matlab s tab completion: When you type the name of an object, followed by a dot, and press tab, a selectable list of the available properties and functions will appear. Most objects will have a name property which helps identify them. They also have the methods: delete to remove itself (please use with care), and isvalid to check whether the object has been deleted. Arguments in Methods Different methods can take arguments in two different ways: Ordered Arguments: Where arguments are simply given as a set of values in a predetermined order. Optional arguments are the last ones in the order. e. g. csf.getwellbyname( Well_1 ) Paired Arguments: Arguments are specified as a set of argument-name, and argument-value pairs. There is no specific order in which the arguments are given. This behavior is particularly useful when there is a large number of optional arguments. e. g. em.addbb( md, 100, unitmd, ft ) CSF Properties a_surfaces : Array of SurfaceData objects a_wells: Array of Well objects depthreference: String indicating reference for depth values geolocationreference: String indicating meaning of horizontal coordinates rcomponentdatabase: Reference to component data base rrockclassdatabase: Reference to rock class data base s_compositiondatabases: Structure with fluids, matrix and shale composition data bases Methods addnewsurface: Adds a new surface with empty data addnewwell: Adds a new empty well to the project getsurfacebyname( name ): Retrieves a surface using its name as reference getwellbyname( name ): Retrieves a surface using its name as reference removesurface( surface index or surface itself): Removes a surface removewell( well index or well itself): Removes a well showsurfacenames: Displays current surfaces names showwellnames: Displays current wells names

5 Well Properties API: API number a_logsets: Array of log sets a_surveyfiles: Array of survey files EM_Calculators: Access to earth model calculators Log_Calculators: Access to log calculators. loglimits: Limits of loaded data: LAS, survey files, etc. Read only modelinglimits: Limits where modeling will take place (simulations, detect boundaries, etc) rdisplayunitsys: Reference to display unit system rem: Reference to earth model rtrajectorydata: Reference to well trajectory data Simulators: Access to simulators (resistivity, nuclear, fluid flow, etc.) totallimits: Total limits considering all elements with data in measured depth. Read only trajlimits: Limits of rtrajectorydata. Read only welldatum: Well Datum in display units Methods getlogsetbyname( name ): Retrieves a log set using its name as reference getsureryfilebyname( name ): Retrieves a log survey file object using its name as reference showlogsetnames: Display current log set names showsurveyfilenames: Display current survey file object names Earth Model Properties ignoreminlayerthickness: If true, allow layers of any thickness minlayerthickness: Minimum allowed layer thickness in meters mdbb: Measured depth of bed boundaries in display units. Read only mdpetrobb: Measured depth of petrophysical bed boundaries in display units. Read only mdmidlayers: Measured depth at middle of layers in display units. Read only mddipdipaz: Array with 3 columns [measured depth, dip, dip azimuth] in display units. Read only numbb: Total number of bed boundaries. Read only numpetrobb: Number of petrophysical bed boundaries. Read only numlayers: Total number of layers. Read only numpetrolayers: Number of petrophysical bed boundaries. Read only numradb: Number of radial boundaries. Read only numradzones: Number of radial zones. Read only

6 radb: Radial boundaries. Read only Methods addbb( ): Add bed boundaries. Paired arguments: o md: Measured depth. Single value or 1d array o mdunit: Unit for measured depth. String. Defaults to display units o dip: Dip values for new bed boundaries. Defaults to 0 o dipazimuth: Dip azimuth for new bed bounfaries. Defaults to 0 o dipunit: Unit for dip and dip azimuth. String. Defaults to display units o ispetro: Whether new bed boundaries are petrophysical. Logical (true / false). Defaults to false addrad( ): Add radial boundaries. Paired arguments: o rad: Radius for new radial boundaries. Single value or array o radunits: Unit for rad. String. Defaults to display units o layeridx: Layers index where for new radial boundaries. Defaults to all layers deletebb( ): Delete bed boundaries. Paired arguments: o md: Measured depth of bed boundary to delete (closest) o mdsegment: Array of two measure depth values. o mdunit: Unit of measured depth. Defaults to display units o idx: Index of boundary to delete o onlynotpetro: Whether to delete only non petrophysical bed boundaries. Logical (true / false). Defaults to false deleterad( radius index ): Delete radius in entire model [prop Val, prop Units] = getproperty: Get property values. It can also return property units. Paired arguments: o propname: Name of property to get. See Table 1, or use em.showpropnames. o propunits: Units of property. Defaults to display units o layeridx: Layer index. Defaults to all layers o zoneidx: Zone index; it can take all as input. Defaults to last zone (formation) showpropnames: Displays available property names movebb: Move a bed boundary to a specific location. Paired arguments: o idx: Index of bed boundary to move o md: Measured depth to where the bed boundary is to be moved o mdunit: Units of measured depth. Defaults to display units setdip: Set bed boundaries dip and / or dip azimuth. Paired arguments o idx: Index of bed boundaries. Single value or array o interval: Pair of measure depths o intervalunit: Units for interval. Defaults to display units o dip: New dip value

7 o dipazimuth: New dip azimuth value o dipunit: Units for new dip and dip azimuth. Defaults to display units setproperty: Set property value. Paired arguments: o propname: Name of property to set. See Table 1 o layeridx: Layer index. Defaults to all layers. o zoneidx: Radial zone index. Defaults to all zones. o value: New value. Single, or array. Must be consistent with number of zone and layer indexes. o units: Units of property being set. Defaults to display units setrad: Set radial boundaries location, assuming the radial boundaries already exist. Paired arguments: o layeridx: Index of layers to set radius. Single value or array. Defaults to all layers o radidx: Index of radius boundary to set. Defaults to first radius (borehole) o rad: Position where the radial boundary is to be set o radunit: Units for rad. Defaults to display units Table 1, Earth model property names Resistivity Resistivity (Perpicular) Relative Electric Permittivity Relative Electric Permittivity (Perpicular) Relative Magnetic Permeability Relative Magnetic Permeability (Perpicular) Spontaneous Potential Bulk Density P-Wave Slowness P-Wave Slowness (Perpicular) S-Wave Slowness S-Wave Slowness (Perpicular) P-Wave Quality Factor P-Wave Quality Factor (Perpicular) S-Wave Quality Factor S-Wave Quality Factor (Perpicular) Shale Concentration Total Porosity Isolated Porosity Shale Porosity Total IC Water Saturation Irreducible Water Saturation Permeability Permeability (Perpicular) Formation Compressibility Salinity Water Resistivity Temperature Pore Pressure Migration Length (AmBe) Migration Length (14 MeV) Thorium Concentration Uranium Concentration Potassium Concentration Photoelectric Factor Neutron Capture Cross Section (Sigma) Hydrogen Index Wettability Index

8 Log Set Properties a_logs: Array of log objects. depthdata: Array of measured depth data points in raw units (depthdataunits) depthdataunits: Units for depth data (raw units of depth log) depthlogidx: Index of depth log within a_logs filename: Name of source file. It can be used to store any string header: Log file header rdepthlog: Reference to depth log object totallogs: Total number of logs. Read only Methods getlogbyname( name ): Get log object by name showlognames: Show available log names Log Properties depthdata: Array with depth data points of depth log from same log set. Read only depthdataunits: Units for depth data. Read only description: String describing log rawdata: Array of values constituting log data rawdataunits: Units for raw data totaldatapoints: Total data points in rad data. Read only Nuclear Simulator Access the nuclear simulator from a well: well.simulators.nuclear Properties allowedphiunits: Structure with allowed equivalent porosity units allowedsimtool: Structure with allowed simulation tools. Read only simtool: Tool to simulate. Assign using one of the allowedsimtools: ns.simtool = ns.allowedsimtool.longhornwl samplingrate: Tool sampling rate boreholediameter: Borehole diameter mudtype: Mud type to use in simulation. Assign using one of the allwedmudtype in tool: ns.mudtype = ns.simtool.allowedmudtype.freshwater usemudcakewl: Whether to use mud cake. Only considered for WL sim tools mcdensity: Mudcake density, only when using usemudcakewl

9 mcthickness: Mudcake thickness, only when using usemudcakewl keeptoolcentered: Only for Longhorn Wireline simtool outphiunits: Equivalent output units for porosity. Assign using one of the allowedphiunits ns.outphiunits = ns.allowedphiunits.sandstone rounddip: Round relative dip to nearest. usespecifiedgrabc: Whether to use specified GRa, GRb and GRc or just defaults. Logical (true / false). Defaults are 6.51, 2.71 and respectively. GRa: Weigh for U concentration in GR GRb: Weigh for Th concentration in GR GRc: Weigh for K concentration in GR doiterationrefinementwl: Whether to do iterative refinement when calculating density, uing WL tools. Logical(true /false) tooldiameter: Tool diameter in inches when simulating density, using Schlumberger LWD. It must be either or 8.25 muddensity: Mud density when simulating density using Schlumberger LWD mudpef: Mud PEF when simulating density using Schlumberger LWD multiplebackgrounddiffusion: Whether to use multiple or single background diffusion when simulating neutron tool. Logical (true / false) linint: Whether the calibration is to be done with linear interpolation of polynomial fit when simulating neutron tool. Logical(true / false) currsimfolder: Folder where a simulation is currently being run. Methods resetgrabc: Resets GRa, GRb and GRc values to their defaults (6.51, 2.71 and 14.23) rundensity: Run density simulation rundensity_and_pef: Run density and PEF simulations rungr: Run gamma ray simulation runneutron: Run neutron tool simulation Resistivity Simulator Access the nuclear simulator from a well: well.simulators.resistivity. Properties tool: Selected tool. Assign using one of the allowedsimtools: rs.tool = rs.allowedtools. AIT variant: Variant for selected tool. Refers to one of the multiple simulation codes available for selected tool. The allowed variants change when the tool changes. Use allowedvariants rs.variant = rs. allowedvariants. Variant 2D_Schlumberger

10 runinseries: Advanced, logical (true / false). Determines if multiple simulations can be started at the same time. Defaults to false. See the Example in this document for how to run parallel simulations. timeout: Numeric value t will cause sim to stop after t seconds. Default is infinity. usedefaultsettings: Logical (true / false). If false this will not apply saved settings when simulation tool or variant is changed. Defaults for that tool/variant will be used. allowedtools: Structure providing easy access to allowed tools. allowedvariants: Structure providing easy access to allowed variants for selected tool. rsimulator: Reference to the selected simulator controller. This object allows fine tuning of the individual simulator code. The object will be slightly different for each simulator. N_RunningSims: Shows number of currently running simulations (used for parallel runs). allowedvariants: Structure providing easy access to allowed variants for selected tool. Methods run: Run resistivity simulation clearsimobject: Advanced, clears sim object stored in rsimulator allowing a separated simulations of the same type to be run with different settings. clearqueue: Advanced, stops and clears all simulations from queue.

11 Examples Resistivity Simulation The following code block is taken from the example Matlab script in the documentation: ScriptingExample_ResistivitySimulator.m. % Demonstrate various scenarios for running resistivity simulation in scripts. % This demo script shows 4 different examples: % 1) RUN SAME VARIANT IN SERIES WITH DIFFERENT SETTINGS % 2) RUN DIFFERENT VARIANTS IN SERIES % 3) RUN SAME VARIANT IN PARALLEL WITH DIFFERENT SETTINGS % 4) RUN DIFFERENT VARIANTS IN PARALLEL WITH DEFAULT SETTINGS % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Setup (Preparation for all sims) % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Set up variables assuming utapwels is started with a well and reasonable % modeling limits (optionally with bedboundaries etc) rwin = uu.hmainwindow; csf = rwin.rcsf; w1 = csf.a_wells(1); rs = w1.simulators.resistivity; alltools = struct2array(rs.allowedtools); N = numel(alltools); toolindices = 1:N; % Set to true to test all available tools (though only 1 variation of each) dofulltest = false; % Set number of setting variations to display for same tool tests Nvariations = 2; % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % RUN SIMS IN SERIES : demo simple series runs % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% rs.runinseries = true; % set to run sims in series % 1. RUN SAME VARIANT IN SERIES WITH DIFFERENT SETTINGS %%%%%%%% rs.tool = rs.allowedtools.hdil; maxdips = 1:Nvariations; N1 = numel(maxdips); fprintf('\nrunning %d simulations in series with different settings\n', N1); tic; for idx = maxdips % change maxtruedipvar and logset name in each case. rs.rsimulator.maxtruedipvar = idx; name = sprintf('hdil 1D ser: max dip var = %d', idx); rs.rsimulator.logsetname = name; % save sim obj to a struct if desired but in this case since we did not create a new % object, all entries will refer to same object. (see Parallel below for creating % new objects). If you want to save the settings then call clearsimobject after each % run but be aware that you must set all non default settings when creating a new object. fldname = matlab.lang.makevalidname(name); S.(fldname)=rs.rSimulator; rs.run; % this now checks if all sims have finished running. while rs.n_runningsims > 0 % In this case we should never enter this disp('error if you see this'); disp(rs.n_runningsims); disp(rs.s_simqueue_); pause(2); t_ser_same = toc

12 Resistivity Example Continued % 2. RUN DIFFERENT VARIANTS IN SERIES %%%%%%%% toolindices2 = toolindices; if not(dofulltest) % Set custom tool indices for case of shorter test toolindices2 = 14:15; N2 = numel(toolindices2); fprintf('\nrunning %d different simulations in series\n', N2); tic for idx = toolindices2 t = alltools(idx); rs.tool=t; % this will generate a new sim object name = t.char; % make changes to tool settings here if desired % rs.rsimulator.maxtruedipvar = 1; rs.rsimulator.logsetname = [name '_ser']; % save sim obj to a struct if desired fldname = matlab.lang.makevalidname(name); S.(fldname)=rs.rSimulator; rs.run; % this now checks if all sims have finished running. while rs.n_runningsims > 0 % In this case we should never enter this disp('error if you see this'); disp(rs.n_runningsims); disp(rs.s_simqueue_); pause(2); t_ser_diff = toc % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % RUN SIMS IN PARALLEL : demo parallel runs % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % You must know what you are doing here! % % Care must be taken in parallel runs for 2 main points. % % 1.) You must either change the tool or call clearsimobject before % changing or running a sim variant that you have already started otherwise % it will change the running sim object which may have unexpected results. % 2.) You must not perform any function that will dep on the resulting % logs until you are sure that the simulations are done. A demo of how to % check is given. (in principle you could check each individually but that % is very advanced). % % Running in parallel can be 2 to 3 times faster, deping on the % computer. rs.runinseries = false; % set to run sims in parallel

13 Resistivity Example Continued % 3. RUN SAME VARIANT IN PARALLEL WITH DIFFERENT SETTINGS %%%%%%%% rs.tool = rs.allowedtools.hdil; maxdips = 1:Nvariations; N3 = numel(maxdips); fprintf('\nrunning %d simulations in parallel with different settings\n', N3); tic; for idx = maxdips % change maxtruedipvar and logset name in each case. rs.rsimulator.maxtruedipvar = idx; name = sprintf('hdil 1D par : max dip var = %d', idx); rs.rsimulator.logsetname = name; % save sim objs to a struct if desired to examine later. Because we % call rs.clearsimobject after each run these will all be different % objects and thus hold the settings changes. fldname = matlab.lang.makevalidname(name); S.(fldname)=rs.rSimulator; rs.run; % This is important before changing settings and running again because % it makes an indepent sim object that won't interfere with the % running object. rs.clearsimobject; % this now checks if all sims have finished running. while rs.n_runningsims > 0 disp(rs.n_runningsims); disp(rs.s_simqueue_); pause(2); disp('now all sims are done'); fprintf('rs.n_runningsims = %d', rs.n_runningsims); t_par_same = toc % 4. RUN DIFFERENT VARIANTS IN PARALLEL WITH DEFAULT SETTINGS %%%%%%%% toolindices4 = toolindices; if not(dofulltest) % Set custom tool indices for case of shorter test toolindices4 = 14:15; N4 = numel(toolindices4); fprintf('\nrunning %d simulations in parallel\n', N4); tic for idx = toolindices4 t = alltools(idx); rs.tool=t; % this will generate a new sim object name = t.char; % make changes to tool settings here if desired rs.rsimulator.logsetname = [name '_par']; % save sim obj to a struct if desired fldname = matlab.lang.makevalidname(name); S.(fldname)=rs.rSimulator; rs.run;

14 Resistivity Example Continued % this now checks if all sims have finished running. while rs.n_runningsims > 0 disp(rs.n_runningsims); disp(rs.s_simqueue_); pause(2); disp('now all sims are done'); fprintf('rs.n_runningsims = %d', rs.n_runningsims); t_par_diff = toc % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Compare the times : %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Now compare the times fprintf(... 'Running %d runs of same variant in series took %f sec\n',... N1, t_ser_same); fprintf(... 'Running %d runs of same variant in parallel took %f sec\n',... N3, t_par_same); fprintf(... 'Running %d runs of different variants in series took %f sec\n',... N2, t_ser_diff); fprintf(... 'Running %d runs of different variants in parallel took %f sec\n',... N4, t_par_diff);