TheTechIdea OilGas - User guide Developer guide →

Configuring your environment

One JSON file - the environment - adapts the views to a customer, country or asset: units, engineering criteria, standards references, names, colours, print settings and your own lexicons, code lists and data mappings.

Step by step

  1. Start from the template (every setting with its default) or a sample.
  2. Keep only the settings you change; everything else keeps its default.
  3. Write measurements with their unit: { "value": 5, "unit": "m" }.
  4. Open the file in an editor that understands the JSON Schema to get completion and error highlighting.
  5. Give the file to the application (your administrator configures where it is loaded). Mistyped keys and invalid values are reported, not silently ignored.

The two examples below are regional: they show how practice in Kuwait and on the Norwegian continental shelf looks in a file. Every country has a preset (see countries) - start from yours with "extends": "country:XX" and override only what differs.

Example: a Kuwait profile

{
  // Kuwait (sample) - feet, Arabic display names for formations, PPDM-style source codes
  "name": "Kuwait (sample)",
  "culture": "ar-KW",
  "units": { "depthUnit": "ft", "pressureUnit": "psi" },
  "printing": { "paper": "A3", "headerFields": { "Country": "Kuwait" } },
  "resources": {
    "vocabularyFiles": [ "ppdm-codes.vocabulary.sample.json" ],
    "lexiconFiles": [ "kuwait.lexicon.sample.json" ],
    "mappingProfilesFolder": "profiles"
  }
}

Example: a Norwegian Continental Shelf profile

{
  // Norwegian Continental Shelf (sample) - only the keys that differ from the defaults
  "name": "NCS (sample)",
  "culture": "nb-NO",
  "units": { "depthUnit": "m", "diameterUnit": "in", "pressureUnit": "bar" },
  "conversion": { "depthMode": "True" },
  "barriers": { "acceptanceReferences": { "CASING": "NORSOK D-010 Rev 5 (verify table)" } },
  "resources": { "lexiconFiles": [ "ncs.lexicon.sample.json" ], "labelFiles": [ "labels.company.sample.json" ] }
}

What you should review for your company

Area Settings Why
Units units.* depth unit, pressure, diameter and weight display units
Barrier criteria barriers.* required barriers per leak path, impaired rule, acceptance-criteria references (your standard and revision)
MAASP screening annuli.* burst and collapse deratings used for screening
Cement cement.* CBL calibration, bond-index cutoffs, required isolation length, logged coverage
Pressure pressure.* fluid-typing gradients, zoning rules, fit quality
Mud gas gasRatios.* Haworth bands and show threshold
Names resources.lexiconFiles, culture layer names used by your company / country and the display language
Codes resources.vocabularyFiles your data model's codes (packer types, string kinds, statuses...)

A company file and country or asset files

Keep company-wide settings in one file and let each country or asset file extend it with only what differs:

{ "extends": "../company/company.environment.json", "units": { "depthUnit": "m" } }

A country file wins over the company file; colour lists merge (change one colour, keep the others). Your administrator can ask the software where any value came from.

Screen themes

Set theme.preset to dark, print or highContrast (default light). The software warns when text would be hard to read.

Checking your files before use

wellbore-config validate <your file> checks the environment, the files it extends, your lexicons, code lists, labels and data mappings, and explains every problem (see the WR messages under Validation messages).

Starting from your country

Ready-made environments exist for 62 countries (see Countries), one complete file each: units by typical national practice, the tubular catalogue (API 5CT / ISO 11960, or GOST in Russia and the CIS, with Russian log mnemonics such as ГК, ПС, КС, ДС grouped into the right tracks), paper size, the code page of older files, and the country's regulators for reference. Start from one and change only what differs for your company; wellbore-config show tells you where every value came from.

{ "extends": "country:NO", "units": { "pressureUnit": "psi" } }

A unit system alone also works: "units": { "system": "metric-mpa" } (oilfield, metric-kpa, metric-bar, metric-mpa); any unit set explicitly wins.

Your own units, unit systems, paper sizes and countries

Nothing is fixed in the libraries: add or change units (units.definitions, for example the US survey foot or kgf/mm2), unit systems (units.systems), paper sizes (printing.papers), and countries - a folder of your own country files (resources.countryFolders) is searched before the built-in ones, and a file there may build on the built-in country.

{
  "resources": { "countryFolders": [ "countries" ] },
  "units": { "definitions": { "kgf/mm2": { "dimension": "Pressure", "factor": 9806650 } } },
  "printing": { "papers": { "B4": { "width": 708.66, "height": 1000.63 } } }
}

Your own equipment, barrier and contact types

The lists of equipment (component) types, well barrier element types and fluid contact types are configuration too. Add your own or change a built-in one in a file listed under resources.modelCatalogFiles; entries with the same code replace the built-in ones, new codes are added.

{ "componentTypes": [ { "code": "DOWNHOLE_FLOWMETER", "category": "Monitoring", "name": "Downhole flowmeter" } ],
  "contactTypes": [ { "code": "HCWC", "name": "Hydrocarbon-water contact", "color": "#224488", "rank": 2, "limit": 0 } ] }

Your own symbols in checks and templates

Barrier templates, annulus detection, P&A checks, validation and the schematic layout recognise items by role - tubing, production casing, packer, safety valve, wellhead, tubing head, tree, BOP, cement plug, plug foundation, control line, open hole and others. Each role lists component types, symbols, symbol prefixes and exclusions (schematic.roles). When you use your own symbols, add them to the role they play; a role you set replaces the built-in definition of that role.

{ "schematic": { "roles": { "tubing": { "symbols": [ "str_tubing", "acme_tubing" ] } } } }

Host slots are configured the same way: schematic.hostRadii (where a slot sits) and schematic.hostFamilies (how it is drawn: tubing, linerInCasing, liner or casing).

Your own leak-path networks

The leak-path diagrams are built from networks defined in JSON: cavities (reservoir, tubing, annuli, surroundings...), fixed edges, and links - "every barrier element of this type (in this envelope) joins these two cavities". Add networks or replace a built-in one by name in a file listed under resources.leakPathFiles, with selection rules that choose it by words in the barrier set's phase or well type (your rules are checked first).

{ "networks": { "gasStorage": { "cavities": [ { "id": "R", "label": "Storage", "kind": "Source" }, { "id": "E", "label": "Surroundings", "kind": "Sink" } ],
                                "links": [ { "type": "CASING", "a": "R", "b": "E" } ] } },
  "selection": [ { "contains": [ "storage" ], "network": "gasStorage" } ] }

Your own barrier templates

The typical barrier sets (production, injection, drilling, workover, permanent abandonment) are templates in JSON. A template names the items it works with by symbol role, which of them are required, and the elements of each envelope - with depths as expressions over named points (casing.toc, casing.cementBottom, packer.top, dhsv.top, plug.base, doc.bottom, max(a, b), min(a, b)) and conditions (liner, casing.cemented, casing.toc < packer.top, joined with and). Change a built-in template or add your own by name in a file listed under resources.barrierTemplateFiles; for example, a production standard that does not require a downhole safety valve:

{ "templates": { "production": {
    "phase": "Production", "wellType": "Producer (company standard)",
    "bind": { "casing": { "role": "productionCasing", "kind": "string" }, "tree": { "role": "tree" } },
    "require": [ "casing" ],
    "envelopes": { "Primary": [ { "type": "CASING", "target": "casing", "top": "casing.top", "bottom": "casing.bottom" } ],
                   "Secondary": [ { "type": "PRODUCTION_TREE", "target": "tree", "when": "tree" } ] } } } }

A misspelt point stops the template with a message naming it.

Saving the whole configuration

wellbore-config save environment.json folder (or WellboreServices.SaveConfiguration(folder) in code) writes the complete configuration - the environment and every part it uses: vocabulary, lexicon and label layers in their order, component symbols, equipment / barrier / contact types, leak-path networks, barrier templates, your own countries, units, and copies of the lithology and symbol-catalogue files - as JSON files referenced by relative paths. Load folder/environment.json to get the same configuration anywhere; the folder can be moved, zipped or put under version control. Parts a program supplied in code rather than as JSON are listed as skipped.

North reference and coordinate systems

Each well records the north its survey azimuths refer to (surveyNorth: Magnetic, True or Grid), the magnetic declination and the grid convergence (well columns survey_north, magnetic_declination, grid_convergence; WITSML aziRef, magDeclUsed, gridCorUsed). Trajectories, maps and sections work in one north (survey.workingNorth, Grid by default): magnetic to true adds the declination, true to grid subtracts the convergence (survey.gridConvergencePositiveEast sets the sign convention). A correction that needs a missing value is reported, never guessed; a well without north information is treated as grid, as before. Maps and sections warn when wells use different coordinate systems (WV060) or when only some declare one (WV061). Each country file lists the coordinate systems commonly used there.

Well identifier formats

Country files carry the national well identifier format where one exists - US API numbers (42-501-20130-03-00), Canadian UWIs (DLS 100/06-12-045-12W5/00 and NTS 200/A-001-B/094-G-01/00), Norwegian wellbore names (15/9-F-12) and UK well names (211/29-A12). When a well is loaded, its UWI (and, for Norway and the UK, its name) must match one of them; otherwise the load reports WI001 with the expected formats. Set your own list in region.wellIdentifiers (name, regular expression, example, fields) - it replaces the country's.

Abandonment rule sets

The P&A checks and the permanent-abandonment barrier set apply a named rule set (abandonment.ruleSet); the checklist and every message name it. Built in, each with the source of every value in its notes:

Rule set Plug (no foundation) On bridge plug / retainer Environmental plug Environmental plug top
default - NORSOK D-010 100 m 50 m 50 m 50 m below the depth zero
US-BSEE - 30 CFR 250.1715 200 ft 50 ft of cement on top 150 ft 150 ft below the mudline
UK-OEUK - OEUK Well Decommissioning Guidelines 100 ft MD 100 ft MD 100 ft 100 ft below the mudline (a check value: OEUK sets no fixed depth)
RU - Rostekhnadzor order No. 534 50 m 50 m 50 m at the sea bed / surface

The US, UK and Russia / CIS country files select their rule set. Depths "below the mudline / surface" use the schematic's surface depth (from the datum and ground / seabed elevations, datum codes GL, SB, ML); when it is unknown the check says so (WP009). Add your own rule set under abandonment.ruleSets; a value you leave empty is reported (WP008) and the checks that need it are skipped, never filled with another rule set's numbers. Always confirm the values against the current edition and your regulator's requirements for the well.

Checking a configuration: verify

wellbore-config verify environment.json runs two kinds of check and exits 0 (clean), 1 (warnings) or 2 (errors or a failed case) for use in CI:

Survey tool error models

Position uncertainty uses a survey tool error model (survey.toolModel, default MWD+SRGM, the OWSG standard MWD model A001Mc). Built in: the ISCWSA MWD Rev 5 model (35 terms, reproducing the ISCWSA example spreadsheets for test wells 1 and 2 at every station) and 53 models of the OWSG Tool Group A (Rev 5.1): MWD with standard, high-definition or in-field referencing, axial correction (AX), sag, multi-station, EMS, gyro (stationary), dipmeter, film, inclination-only, blind and unknown tools. MWD+SRGM reproduces Copsegrove's ISCWSA diagnostics for test wells 1 to 3; every OWSG weighting function agrees with welleng, an independent implementation, except where the official formulas are followed and welleng differs (ABIZ, the vertical-station forms of CNA / XYM3 / XYM4, and XCLA, where welleng and Copsegrove use the sine of the azimuth change). Models warn when the survey leaves their inclination range or, for axial correction, enters the horizontal east / west exclusion zone. Gyro models switch between stationary and continuous surveying at staticGyroEndInclination (negative: continuous from surface): terms can be limited to an inclination zone (incMin, incMax), carry a stationary initialisation error into continuous surveying (carryAboveMax) or be an initialisation seed (carryOnly); continuous drift and random walk accumulate with the running speed and restart when the well drops back below the switch and is re-initialised (SPE 90408 Appendix C). The six SPE 90408 example models reproduce the paper's Appendix E on ISCWSA wells 1 and 3 (Model #4 on well 3 from 3000 m excepted: the published values there are inconsistent). Built in: GYRO-NS-CT and the CB_Film GMS / GSS continuous models.

A term can also be given by formulas instead of a built-in function (depthFormula, inclinationFormula, azimuthFormula and the northSingularity / eastSingularity / verticalSingularity forms for vertical stations), written as the ISCWSA and OWSG models write them - for example Sin(AzT) / (EarthRate * Cos(Latitude) * Cos(Inc)) - with the variables MD, MDPrev, Inc, IncPrev, AzT, AzTPrev, AzM, Az, TVD, Dip, Gfield, BField, Latitude, EarthRate, NoiseReductionFactor, XCLTortuosity, RAD, pi and the model's own parameters. ToolErrorModel.FromIscwsaJson reads the ISCWSA error-model JSON format. An unknown name or a syntax error is reported and the term left out.

A well surveyed with several tools has a survey program: legs from a start depth, each with its tool model (WellModel.SurveyProgram), or the tool of each survey station (CSV column survey_tool, WITSML trajectoryStation/modelToolError) from which the legs are derived. Random errors are independent at every station, systematic errors are correlated within a leg and independent between legs, and well-by-well and global errors are correlated across all legs (SPE 67616). A tool that is not one of survey.toolModels is reported (WV064) and replaced by survey.toolModel. Add your own models under survey.toolModels: each term has a code, a weighting function (DREF, DSF, DST, ABXY-TI1, ABXY-TI2, ABZ, ASXY-TI1..3, ASZ, MBXY-TI1..2, MBZ, MSXY-TI1..3, MSZ, AZ, DBH, AMIL, SAGE, XYM1..2, XYM3L, XYM4L, XCLH, XCLA), a magnitude with its unit (m, -, 1/m, m/s2, nT, deg, deg.nT) and a propagation (random, systematic, global). The sensor terms need the well's magnetic field (total field and dip) and declination: taken from the well header (magneticTotalField, magneticDip, magneticDeclination, gravity) when given, otherwise computed at the well's location and survey date with the World Magnetic Model 2025 (embedded; resources.geomagneticModelFile loads another model in NOAA .COF format) and WGS84 normal gravity. Without a location the simple error model is used; the view's validation says so (WV062), and when no survey date is given the field is computed for today (WV063).

Coverage: what your data holds that the environment does not resolve

wellbore-config coverage <environment.json> <source> [--worksheet file] loads the wells of a configured data source and lists every value that does not resolve, by area, with how often it occurs, a well holding it and the setting that fixes it: codes that are not string kinds or statuses (fix: dataSources.<source>.codes), component types that are not in the model catalog or have no schematic symbol (codes, resources.modelCatalogFiles, resources.componentSymbolsFile), contact types, formation tops not in any stratigraphic lexicon (resources.lexiconFiles), lithologies not in the lithology library (resources.lithologyFile), unknown units (units.aliases) and, for LAS / DLIS / WITSML sources, curve mnemonics that match no curve rule (logs.mnemonicAliases). --worksheet writes the unresolved codes as a codes skeleton to fill in and to-do lists for the rest - a working file, not configuration. The command exits with 1 while anything is unresolved, so a CI step can require full coverage. From code: DataCoverage.Analyse(source) (and MappedWellDataProvider.ObserveAsync for the raw and resolved values of one well).

Standard stratigraphy and your own

Formation tops resolve through stratigraphic lexicons in layers: your lexicon files first (resources.lexiconFiles - your formations, groups and members with their aliases and local names), then the published standards in resources.standardLexicons - built in: ICS, the International Chronostratigraphic Chart v2020/01 (178 units from eons to ages, with ranks, hierarchy, boundary ages in Ma, the official CGMW colours and names in 20 languages; "Upper Jurassic" and "Late Jurassic" both resolve). Your names always win. A unit can name its rank, its parent (a company formation can sit in a chart stage: "parent": "Albian") and its base and top ages. Tops show on schematics and log views alike, named and coloured by their unit (styles.topMarkerColor for tops outside the lexicons); with display.chronostratigraphyRank set (Period, Epoch, Age ...) the views add chronostratigraphy zones - each top's chart unit of that rank, with its colour and age range. Set "standardLexicons": [] to use only your own; to use a newer ICS edition, rebuild the layer with tools/standards/build_ics_lexicon.py or add it as one of your lexicon files.

Toolboxes

Toolboxes are libraries on top of the core, each its own package: Integrity (wall loss, corroded-pipe re-rating, sustained casing pressure, integrity status), Drilling (well planning, torque and drag, hydraulics, performance), Production (decline curves, inflow and nodal analysis, pressure tests), DataAI (legacy document extraction, well identity reconciliation, OSDU ingestion) and Training (scenario exercises on the views). Each keeps its settings in the same environment file, under toolboxes:

"toolboxes": { "integrity": { ... }, "drilling": { ... } }

They merge through extends and presets like every other section, are validated with the rest (messages start toolboxes.<name>:), and appear in the template and schema with their defaults. A company can add its own toolbox section too.

They behave like every other section in the tools: wellbore-config validate reports a mistyped key (unknown key 'toolboxes.integrity.wallBasisX' (ignored), also inside extends files) and checks the files and folders a toolbox points to; show and diff report each toolbox's effective settings - its defaults with your values over them - and where each came from; template lists every toolbox; and the name of a section may be written in any case. A section of your own toolbox (one this release does not know) is left alone.

Nothing a company may want to change is fixed in the code. Weights, tolerances, limits, resolutions, ports and typical values are settings of the environment; the numeric constants that remain are physics, mathematics or structure, each justified in a test that fails when a new one appears.

Time zone

Times are stored in UTC. Displayed and printed times use locale.timeZone (an IANA or Windows id such as Europe/Oslo or America/Denver; empty: the machine's own zone) - so a report printed on a server running in UTC carries the company's date, not the server's.

Every view follows the environment

Schematics, log tracks and templates, the composite well view, correlation panels, cross-sections, well maps, crossplots, the symbol view and every print take their colours from the theme and styles, their numbers and dates from the display culture, their depths from the depth unit and their curve colours from the curve rules (logs.styles, also for the curves the library builds itself - triple combo, gas, core, cement bond). Text on coloured badges (barrier and annulus status, leak paths, flags, change markers) is black or white, whichever reads on the badge's configured colour. Diameters in barrier tables and generated names (open hole) follow units.diameterUnit: oilfield fractions when it is inches ("9 5/8 in"), converted values otherwise ("244,5 mm"). New annotations use styles.annotationColor, markers and tops without a unit colour styles.topMarkerColor, Pickett plots crossplots.pickettWaterLine / pickettSwLine. A test renders every view family in a company environment and fails if a default colour, a decimal point in a comma culture or a fixed unit shows through.

National lithology standards

The lithology library carries the FGDC (USA) pattern numbers. resources.lithologyStandards layers national standards on top: "GOST 21.302-2013" is built in (the Russia / CIS interstate standard, adopted by Azerbaijan, Armenia, Belarus, Kazakhstan, Kyrgyzstan, Moldova, Russia, Tajikistan and Uzbekistan; the AZ, BY, KZ, RU and UZ presets select it). Its Table 4 numbers and names become aliases - Песчаник, ГОСТ 21.302-28 and GOST 21.302-28 all mean sandstone - for the 29 entries that are rocks of the library; the other entries (marl, gypsum, loess, peat, tuff ...) stay unmapped and appear in the coverage report rather than being drawn with a guessed pattern.

The standard's drawings are images in the standard and are not reproduced. A company that draws to GOST 21.302 uses its own approved CAD hatch library - the AutoCAD .pat file its drawings pass review with: list it in a standard file and name a pattern per rock -

{ "name": "ACME GOST", "patFiles": [ "acme-gost.pat" ], "entries": [],
  "overrides": [ { "code": "sandstone", "hatchPattern": "PESCHANIK", "hatchScale": 4, "foreground": "#000000", "background": "#ffffff" } ] }

hatchScale is the number of pixels per pattern unit (about 4 for a pattern drawn in millimetres). The .pat format is read as Autodesk documents it (angle, origin, offset between lines, dashes; dots and gaps). A pattern name that is not in the file is reported and the rock keeps its drawing. Other drawings can also be given directly - { "name": "...", "entries": [ ... ], "overrides": [ { "code": "sandstone", "pattern": "Dots", "spacing": 6, "foreground": "#000000", "background": "#ffffff" } ] }. The standard sets no symbol sizes (clause 3.1) and black as the base colour (clause 3.8).

Standards behind the defaults

The default abandonment rule set follows NORSOK D-010:2021+AC:2024 (rev. 5): cement plugs 100 m MD (open hole: at least 50 m above any source of inflow), 50 m MD on a mechanical or cement foundation, the environmental (open hole to surface) plug 100 m MD - or 50 m MD on a mechanical plug (abandonment.environmentalPlugFoundationLength). Only some standards allow that reduction: a rule set without environmentalPlugFoundationLength keeps its full environmental-plug minimum on a mechanical plug (the built-in US-BSEE - 150 ft, 30 CFR 250.1715 - UK-OEUK and RU rule sets state theirs explicitly). Country presets select their national rule set where one is built in (US, GB, Russia / CIS); the others use NORSOK D-010. The API tubular catalogue follows API Spec 5CT 10th edition / ISO 11960 (grades of its scope with the usual type designations - L80-13Cr, N80Q ...; M65 was withdrawn); the GOST catalogue GOST 632-80 / 633-80. Pressure gradients can be given in any gradient unit of the catalogue (psi/ft, psi/100ft, kPa/m, bar/m, MPa/m, MPa/100m, kgf/cm2/m) or as a density (equivalent mud weight); a pressure setting in any other unit is a validation error, never misread. New tops, pressure points and other model objects start in units.depthUnit / units.pressureUnit; image logs assume logs.imageBoreholeDiameter when the image gives no hole size. Curve values meaning "no data" are loaders.nullValues (default -999.25) wherever curves are drawn and checked, and the DLIS default; LAS files use their own declared NULL. A WITSML store client needs its endpoint set - there is no default server. Its request timing is live.witsmlTimeoutSeconds (30), live.witsmlRetries (3) and live.witsmlRetryDelaySeconds (1, doubled per retry) - raise them for slow links such as satellite. Schematic tracks use conversion.dimensioning (Scaled or Schematic) unless a view sets its own, schematic labels theme.labelFontSize; depth units anywhere (LAS, WITSML, documents) accept the spellings of units.aliases. Curve rules (logs.styles) can set a company's standard scale - "min": 0, "max": 150, "unit": "gAPI" - used for loaded logs (converted into each curve's unit, e.g. a density rule in g/cm3 on a curve in kg/m3) and for the built-in templates; without one, loaded curves are scaled to their data. A conductivity curve (a Russian ИК in mS/m, a CILD in mmho/m) that belongs on a resistivity track is drawn as resistivity, R = 1 / σ (100 mS/m -> 10 ohm.m), with "(from conductivity)" in its name; the data itself is not changed. Analysis reads curves in their units too: water saturation and the Pickett plot take resistivity in any resistivity unit or from a conductivity curve (1 / σ), and porosity in %, pu or v/v; the porosity curve is the petrophysics.inputs.porosity role (default PHIT, then PHID), so a company's own mnemonic (e.g. КП) is used. Crossplot axes are crossplots.pickettRtRange (0.1-1000 ohm.m), pickettPorosityRange (0.01-1), densityNeutronNeutronRange (-0.05-0.45) and densityNeutronDensityRange (1.95-2.95 g/cm3); points outside them are reported with the setting to widen, not dropped silently. Shale volume compares the gamma ray with petrophysics.grClean / grShale in petrophysics.grUnit (default gAPI; uR/h - мкР/ч - for Russian / CIS gamma-ray logs, with clean / shale values in that unit). A GR curve in a unit that cannot be converted to it is reported and shale volume skipped, rather than reading every zone as clean. The cement bond index reads the CBL in cement.amplitudeUnit (mV, the unit of the free-pipe and bonded amplitudes): a CBL in V or uV is converted; a curve whose unit is not an amplitude (e.g. %) gives no bond index, with the reason in the curve's name. Every text the views draw themselves - track titles, legend title and entries, empty-track messages, crossplot names and axes, view and accessibility names, header fields - comes from resources.labelFiles (key -> text, e.g. "legend.title": "Tegnforklaring"), with the English text when a key is not given; a test fails if drawing code writes a word that bypasses the labels. Dogleg severity is expressed per survey.doglegCourseLength (none: 100 ft for surveys in feet, 30 m in metres; the Russia / CIS presets use 10 m, the national practice, with the equivalent 5 deg / 10 m warning).

Your libraries and catalogues

The built-in lithologies also answer to the lithologic pattern numbers of the US federal standard FGDC-STD-013-2006 (USGS Techniques and Methods 11-A2, section 37) where the standard has an exact equivalent: sandstone FGDC-607 / 608, siltstone 616, shale 620 (clay or clay shale), limestone 627, dolomite 642, chalk 626, salt 668, coal 658, conglomerate 601 / 602 - so data coded with those numbers resolves without a code map. Anhydrite (FGDC has gypsum, 667), basement and claystone (620 is shale) have no exact equivalent and are not mapped. resources.lithologyFile replaces the built-in lithology library and resources.symbolCatalogFile the built-in symbol catalog for every view, track, conversion, validation and print (a file that is missing or broken is reported in the warnings and the built-in one is used). The tubular catalogue (tubulars: API 5CT / ISO 11960 by default, GOST 632-80 / 633-80 in the Russia / CIS country files ...) is what schematic validation checks strings against: a casing or tubing outside diameter that is not a standard size (WS080, with the nearest size), or a grade or connection not in the catalogue (WS081, WS082) is reported for review; conductors and other sizes outside the catalogue are not judged. Every setting of the environment is used by the libraries - a test fails if one is added that nothing reads.

Your data sources

The company's own data is part of the environment (dataSources): each source has a kind (csv folder, excel workbook, edmXml export, las, dlis, witsml file - or a kind your application registers, such as a database), a path relative to the environment file, the mapping profile it is read with, and your overrides over that profile - your code values (codes: entity, field, source code -> canonical code, for example your PPDM tubing types) and row filters (where, for example the EDM design case). wellbore-config sources <environment.json> loads each source once and says what came out. To confirm a source in CI, add verification cases of kind dataSource (expected well name, counts, curve values at given indices, most warnings allowed - 0 means every code mapped); vendor dip picks go in as dipCorrection cases. Saving a configuration keeps the data paths pointing at the same files; data is not copied.

Excel workbooks

An Excel workbook (.xlsx) is a data source like a CSV folder: each worksheet is a table named by the sheet and its first row holds the column names, so the same mapping profile serves both (new ExcelTabularSource(path)). Numbers, text, booleans and dates (recognised by the cell's number format, in the 1900 or 1904 date system) are read; formulas give the values Excel last saved; error cells are empty. No extra software or package is needed.

Landmark EDM and OpenWells

EdmXmlTabularSource reads a Landmark EDM XML export (each element a row of its table: CD_WELL, CD_WELLBORE, CD_HOLE_SECT...), and the built-in edm profile maps it - or the same tables in an EDM database - to wells, wellbores, hole sections, casing strings, formation tops and definitive survey stations. It is a starter profile (marked verify): its table and column names come from an EDM export and the welleng EDM reader, and its notes list what was observed and what follows the EDM convention. EDM does not record the casing role in its hole sections, so add a code map for the kind; a database with several design cases (PLAN / ACTUAL) needs a where filter on hole_sect_group_id. OpenWells keeps these entities in the same EDM tables; its reporting tables are not mapped.

Any profile can filter rows ("where": { "column": "value" }), compute fields from the numeric columns of a row ("top": "=md_shoe - length") and join related tables of a normalised model ("joins": { "EQUIPMENT": { "on": "EQUIPMENT_ID" } }, then fields such as "type": "EQUIPMENT.EQUIPMENT_TYPE"). The built-in ppdm39 profile uses only tables and columns that exist in PPDM 3.9 (checked against the PPDM 3.9 model, and by a test); the code values of your PPDM implementation still need code maps.

DLIS files

DLIS (API RP66 version 1) files load like LAS (DlisReader.LoadFile): the ORIGIN object names the well, every frame becomes a log set indexed by its first channel (depth, or time), and scalar channels become curves; array channels such as waveforms and images stay in the decoded file (DlisLoadResult.File) and are listed in the warnings. Every object and attribute is available from DlisFile (all 27 representation codes, including IBM and VAX floats). Storage unit labels after leading bytes, several storage units, Tape Image Format wrapping, padding, checksums and trailing lengths are handled; encrypted records are skipped and said; a broken file gives a clear error and never crashes the host. DLIS has no standard "no data" value: DlisReadOptions.NullValues (default -999.25). Verified against dlisio on its 158 test files (tools/verification/dlis).

Numbers and dates on screen

locale.culture sets how numbers look on screen and in printed output (for example de-DE: decimal comma); empty keeps the invariant format (decimal point). locale.dateFormat and locale.dateTimeFormat are .NET date patterns (default yyyy-MM-dd and yyyy-MM-dd HH:mm; empty: the culture's own short date and time). locale.calendar is Gregorian (default - also for cultures whose own calendar differs, such as ar-SA or th-TH) or Culture. Every country environment sets its culture, so "extends": "country:DE" gives decimal commas and dd.MM.yyyy on screen. Files - CSV, LAS, WITSML, JSON, saved views and configuration - never follow the locale or the machine's culture; tallies and casing programmes stay invariant too, because the same table is exported as CSV.

Dip conventions

Dip picks may be true dips (against the horizontal) or borehole-relative (against the plane across the hole, as dipmeters and image logs measure them), with azimuths from north or from the high side of the hole (clockwise looking down-hole), referred to true, grid or magnetic north. Each pick can say so (frame, azimuthReference, northReference); picks that do not use the environment's dips section (default: true dips, azimuths from north, the well's survey north). Dip tracks show true dips in the working north (borehole-relative picks converted with the well's survey; without one a vertical hole is assumed and said); image logs draw each pick's sinusoid from its dip relative to the hole, in the image's own orientation (North or TopOfHole). verify checks the conversion against reference picks (kind dipCorrection); built in are analytic cases.

Files from other countries

LAS and CSV files are read correctly whatever their text encoding. Files marked as Unicode, and files in UTF-8, need no setting. Older files use a regional code page: set the one your files use, for example Cyrillic files from Russia and the CIS (often windows-1251, sometimes cp866), Chinese (gbk), Japanese (shift_jis), Arabic (windows-1256); the default is Western European (windows-1252). When a file is read with this code page, a message says so; a single file can override it.

{ "files": { "legacyEncoding": "windows-1251" } }

Equipment details and the completion table

Say which details each kind of equipment must or may have - ratings, materials, serial numbers, or your own fields - and what values are acceptable. Rules for * apply to all equipment, PACKER_* to every packer type, an exact code to that type only. Problems appear with the other validation messages (WE001-WE005). The completion table shows the columns you list, your own fields included.

{ "equipment": {
    "attributes": { "PACKER_*": [ { "key": "pressureRating", "label": "Working pressure", "kind": "quantity", "unit": "psi", "required": true, "max": 15000 },
                                  { "key": "elastomer", "label": "Elastomer", "kind": "choice", "choices": [ "HNBR", "FKM", "AFLAS" ] } ] },
    "tallyColumns": [ { "key": "no", "header": "#" }, { "key": "name", "header": "Component" }, { "key": "top", "header": "Top" },
                      { "key": "pressureRating", "header": "WP" }, { "key": "elastomer", "header": "Elastomer" }, { "key": "serial", "header": "S/N" } ] } }

By default nothing is required, so existing wells show no new messages, and the table keeps its usual columns.

Every print and export (PDF, SVG, PNG - single wells, correlation panels, cross-sections), every view on screen and the documentation carry a small footnote with the logo, "The Tech Idea™" and the built-in The Tech Idea logo by default. Set the branding section to change the text, use another logo (PNG or JPEG next to the environment file), hide the logo, or switch the footnote off for exports or for the screen:

{ "branding": { "footnote": "The Tech Idea™", "logoFile": "logo.png", "showLogo": true, "showInExports": true, "showOnScreen": true } }

Page templates

Name the page layouts you print often; each changes only what it names (paper, orientation, margin, scale, header block, legend, title, footer, extra header fields). Footer texts take tokens: {well}, {title}, {reference}, {range}, {scale}, {page}, {pages}, {date}.

{ "printing": { "templates": {
    "a3-log":   { "paper": "A3", "scaleRatio": 200, "title": "Completion log", "footerLeft": "{title} · {well}" },
    "overview": { "scaleRatio": 0, "landscape": true, "includeLegend": false } } } }

Correlation panels print at the same scale across several pages (a flattened panel is printed on one page); cross-sections print on one page.

Changing the words on screen

Track titles, table headers, print header fields, legend groups and status badges can use your company wording or language. Put the texts you want to change in a labels file and list it under resources.labelFiles; anything you leave out keeps the text below.

KeyBuilt-in text ({0}, {1} = filled in)
abandonment.noDataNo schematic
abandonment.titlePERMANENT ABANDONMENT CHECKLIST
anticollision.cylinderNotedistance normal to the reference well, direction from north
anticollision.distanceCentre-to-centre distance and MASD
anticollision.noDataNo offset wells scanned
anticollision.referenceMdReference MD
anticollision.sfSeparation factor
barriers.annuliAnnuli
barriers.noDataNo well barrier data
barriers.noReadingno reading
barriers.notesNotes:
barriers.titleWELL BARRIER SCHEMATIC
casing.burstBurst
casing.collapseCollapse
casing.notRatedNot rated
casing.tensionTension
corrosion.jointJoint
corrosion.penetrationPenetration
crossplot.densityNeutronDensity-neutron
crossplot.densityNeutron.xNeutron porosity (v/v, limestone units)
crossplot.densityNeutron.yBulk density (g/cm3)
crossplot.pickettPickett
crossplot.pickett.xDeep resistivity Rt (ohm.m)
crossplot.pickett.yPorosity (v/v)
curve.bondIndexBond index
curve.bondIndex.notAmplitudeCBL unit is not an amplitude
curve.fromConductivity{0} (from conductivity)
depth.mdMD
depth.tvdTVD
header.depthReferenceDepth reference
header.depthUnitDepth unit
header.fieldField
header.fitToPagefit to page
header.intervalInterval
header.operatorOperator
header.printedPrinted
header.scaleScale
header.uwiUWI / API
header.wellWell
integrity.nonCompliantnot compliant
integrity.wellswells
leakpaths.holdingholding
leakpaths.metMET
leakpaths.noDataNo barrier data
leakpaths.nonenone
leakpaths.notMetNOT MET
leakpaths.summaryWeakest leak path: {0} barrier(s) — requirement {1}: {2}{3}
leakpaths.unverified (relies on unverified elements)
legend.annulus.fluidsAnnulus fluids
legend.azimuthAzimuth (0-360°)
legend.borehole.imageBorehole image
legend.completion.equipmentCompletion equipment
legend.core.point.dataCore / point data
legend.curvesCurves
legend.dipsDips
legend.doglegDogleg severity
legend.gasGradientGas gradient
legend.group.pressurePressure
legend.group.trajectoryTrajectory
legend.inclinationInclination (0-90°)
legend.lithologyLithology
legend.oilGradientOil gradient
legend.pressurePressure
legend.shadingShading
legend.titleLegend
legend.trajectoryTrajectory
legend.waterGradientWater gradient
legend.well.barriersWell barriers
live.liveLIVE
live.staleSTALE
live.waitingWAITING
mapping.azimuthazimuth
mapping.bubbleRuleArea is proportional to the value
mapping.contourIntervalContour interval
mapping.degreesdegrees
mapping.eastingEasting
mapping.elevationElevation
mapping.elevationAngleelevation
mapping.noSceneNothing to show
mapping.noSurfaceNo surface
mapping.northN
mapping.northingNorthing
mapping.plannedplanned
mapping.surfacessurfaces
mapping.verticalExaggerationVertical exaggeration
mapping.wellswells
pay.cutoffscutoffs
pay.grossGross
pay.hcColumnHC column
pay.netPayNet pay
pay.netReservoirNet res.
pay.ntgN/G
pay.porosityPHI
pay.swSw
pay.vshVsh
pressure.axisPressure [{0}]
program.col.bottomBottom
program.col.connectionConnection
program.col.gradeGrade
program.col.holeHole
program.col.idID
program.col.nameString
program.col.no#
program.col.odOD
program.col.sourceSource
program.col.tocTOC
program.col.topTop
program.col.weightWeight
program.titleCasing & tubing program
tally.col.bottomBottom
tally.col.connectionConnection
tally.col.gradeGrade
tally.col.idID
tally.col.lengthLength
tally.col.manufacturerManufacturer
tally.col.nameComponent
tally.col.no#
tally.col.odOD
tally.col.partPart no.
tally.col.serialSerial no.
tally.col.sourceSource
tally.col.topTop
tally.col.tvdTop TVD
tally.col.typeType
tally.col.weightWeight
tally.titleCompletion tally
timeDepth.daysDays
timeDepth.depthDepth
timeDepth.noDataNo report
track.abandonmentP&A checklist
track.barriersWell barriers
track.bondFlagsBond
track.bondIndexBond index
track.casingDesignCasing design
track.cblCBL
track.changesChanges
track.chromatographChromatograph
track.chronostratigraphyChronostratigraphy
track.corePermeabilityCore permeability
track.corePorosityCore porosity
track.corrosionCorrosion
track.cuttingsCuttings
track.depthDepth
track.dipsDips
track.flagsFlags
track.gasCharacterFluid (Haworth)
track.gasRatiosGas ratios
track.imageImage
track.intervalsZones
track.leakpathsLeak paths
track.paySummaryPay summary
track.pressureFormation pressure
track.schematicCompletion
track.tallyCompletion table
track.trajectoryDeviation
track.waveformVDL
track.wellpathWell path
training.correctCorrect.
training.incorrectNot correct.
training.notAnsweredNot answered.
training.partlyCorrectPartly correct.
trajectory.noSurveyno survey
trajectory.tdTD
view.contourMapContour map
view.correlationWell Correlation
view.correlation.accessibleCorrelation panel
view.crossSectionCross-section
view.crossplotCrossplot
view.integrityBoardWell integrity
view.ladderPlotLadder plot
view.scene3d3D scene
view.timeDepthTime-depth
view.travellingCylinderTravelling cylinder
view.wellLogWell Log Canvas
view.wellMapWell map
view.wellboreWellbore View
view.wellbore.accessibleWellbore view
waveform.timeAxistime [µs]
wellPath.noDataNo survey / schematic

All settings

KeyTypeDefaultMeaning
Top level
schemaVersionint1Environment file schema version.
extendslistnullBase environment file(s) this one extends (a company base, then country / asset overlays); later files win, objects merge key by key, lists are replaced. Paths are relative to this file.
namestring"Default"Name of this environment, e.g. customer or country profile.
culturestring"en-US"Culture for labels and localized layer names, e.g. en-US, nb-NO.
descriptionstringnullFree text description.
units - Units.
units.systemstringnullUnit system filling the unit settings not set explicitly (a key of units.systems).
units.systemsmap{"oilfield": {"depthUnit": "ft", "pressureUnit": "psi", "diameterUnit": "in", "weightUnit": "lbm/ft", "forceUnit": "klbf"}, "metric-kpa":…Unit systems by name (depth, pressure, diameter, weight units); add your own.
units.definitionsmap{"m": {"dimension": "Length", "factor": 1, "offset": 0, "aliases": ["meter", "meters", "metre", "metres"]}, "ft": {"dimension": "Length",…Unit definitions by symbol (dimension, factor to SI, offset, aliases); add or override units.
units.aliasesmap{}Other spellings of known units (spelling -> unit symbol, e.g. "FEET": "ft"); adds names without redefining the unit.
units.depthUnitstring"ft"Default depth unit for new views and conversions: ft or m.
units.pressureUnitstring"psi"Pressure display unit (tables, readouts): psi, kPa, MPa, bar.
units.diameterUnitstring"in"Diameter display unit in tables: in or mm.
units.weightUnitstring"lbm/ft"Linear weight display unit in tables: lbm/ft or kg/m.
units.forceUnitstring"klbf"Force display unit (tension ratings and loads): klbf, lbf, kN, daN, tf.
display - Display defaults.
display.minZoomSpanmeasure{"value": 0.5, "unit": "ft"}Deepest zoom: the smallest depth span a view shows, converted to each axis's unit.
display.chronostratigraphyRankstringnullChart rank shown as chronostratigraphy zones beside the tops (Period, Epoch, Age ...); empty: no zones.
display.trackGapfloat6Gap between tracks (px).
display.headerHeightfloat28Minimum track header height (px); tracks may grow it.
display.depthScaleModestring"True"Default depth scale of new axes: True or Compressed.
display.compressionPowerfloat0.5Compressed depth: exponent applied to gaps between features (0-1; lower compresses more).
display.minGapPxfloat8Compressed depth: minimum height of a compressed gap (px).
theme - Theme colours and fonts.
theme.presetsmap{"light": {}, "dark": {"trackBackground": "#161b22", "depthTrackBackground": "#0f141a", "grid": "#30363d", "headerFill": "#1f2630", "head…Theme presets by name (colour keys filled under the explicit ones); add your own or change the built-in ones.
theme.presetstringnullTheme preset applied under the explicit keys: a name from theme.presets (light, dark, print, highContrast or your own).
theme.trackBackgroundstring"#f8f9fc"Track background colour.
theme.depthTrackBackgroundstring"#f1f4f9"Depth track background colour.
theme.gridstring"#c8ced8"Grid line colour.
theme.headerFillstring"#e4e9f1"Header fill colour.
theme.headerBorderstring"#aab0ba"Header border colour.
theme.textstring"#262e3a"Text colour.
theme.depthLabelstring"#2c343e"Depth label colour.
theme.framestring"#a6aeb8"Frame colour.
theme.selectionstring"#0078d7"Selection highlight colour.
theme.cursorstring"#c82828"Depth cursor colour.
theme.frameWidthfloat1.25Frame line width (px).
theme.titleFontSizefloat12Track title font size (px).
theme.subtitleFontSizefloat10Track subtitle font size (px).
theme.labelFontSizefloat10Label font size (px) of schematic equipment labels.
theme.depthFontSizefloat11Depth label font size (px).
theme.markerWidthfloat1.4Top / marker line width (px).
theme.surfacestring"#fdfdfd"Canvas surface colour.
theme.surfaceBorderstring"#b1b6bf"Canvas surface border colour.
theme.sectionHeaderstring"#505a69"Section header bars in tables (e.g. Annuli).
styles - Domain styles (barriers, contacts, dips, fluids, palettes).
styles.topMarkerColorstring"#6b5b3a"Colour of a formation top whose stratigraphic unit has no colour.
styles.annotationColorstring"#e65100"Colour of new annotations.
styles.barrierPrimarystring"#1f5fa8"Primary well barrier colour (NORSOK D-010 convention: blue).
styles.barrierSecondarystring"#c0392b"Secondary well barrier colour (NORSOK D-010 convention: red).
styles.barrierEnvironmentalstring"#2e8b57"Environmental (surface) barrier colour (P&A convention: green).
styles.changeAddedstring"#2e963c"State comparison: added item colour.
styles.changeModifiedstring"#e68200"State comparison: modified item colour.
styles.changeRemovedstring"#c81e1e"State comparison: removed item colour.
styles.contactColorsmap{"GOC": "#d63a2f", "GWC": "#2e8b57", "OWC": "#1f5fa8", "FWL": "#0b3d91", "GDT": "#d63a2f", "ODT": "#8a5a10", "OUT": "#8a5a10", "WUT": "#1…Fluid contact colours by code (GOC, GWC, OWC, FWL, GDT, ODT, OUT, WUT).
styles.dipColorsmap{"Bedding": "#282828", "CrossBedding": "#8c6e1e", "FractureOpen": "#d63a2f", "FractureHealed": "#2e8b57", "Fault": "#8e44ad", "Unconformi…Dip pick colours by type (Bedding, CrossBedding, FractureOpen, FractureHealed, Fault, Unconformity, Unknown).
styles.annulusFluidColorsmap{"Brine": "#9fd3f0", "Water": "#bfe3f7", "WaterBasedMud": "#b89a6a", "OilBasedMud": "#7a5a3a", "Diesel": "#f0dc82", "PackerFluid": "#8fc9…Annulus fluid fill colours by fluid (Brine, Water, WaterBasedMud, OilBasedMud, Diesel, PackerFluid, Nitrogen, Gas, Cement, Unknown).
styles.gasCharacterColorsmap{"VeryDryGas": "#f2b6b0", "Gas": "#d63a2f", "GasWithOil": "#e07b39", "Oil": "#2e8b3c", "ResidualOil": "#6b5b3a"}Mud-gas fluid character colours (VeryDryGas, Gas, GasWithOil, Oil, ResidualOil).
styles.pressureFluidColorsmap{"Gas": "#d63a2f", "Oil": "#2e8b3c", "Water": "#1f5fa8", "Unknown": "#5a5a5a"}Pressure gradient colours by fluid (Gas, Oil, Water, Unknown).
styles.bondColorsmap{"Good": "#2e7d32", "Partial": "#f0a020", "Poor": "#c62828"}Cement bond quality colours (Good, Partial, Poor).
styles.statusColorsmap{"Intact": "#2e7d32", "Unverified": "#787878", "Impaired": "#dc8200", "Failed": "#c81e1e", "Open": "#969696", "Pass": "#2e7d32", "Fail": …Status colours: barrier elements (Intact, Unverified, Impaired, Failed, Open), requirement (Pass, Fail), annuli (Ok, AboveMawop, AboveMaasp, NoData), live feed (Live, Stale, Waiting), documents (Planned, AsBuilt), off-line wells (OffLine).
styles.sectionColorsmap{"Steel": "#3a3f47", "Cement": "#c9c3b5", "OpenHoleFill": "#f3efe6", "OpenHoleEdge": "#787878", "Equipment": "#141414", "WellPath": "#1e1…Well-path / cross-section drawing colours (Steel, Cement, OpenHoleFill, OpenHoleEdge, Equipment, WellPath).
styles.correlationPalettelist["#6b5b3a", "#b8a600", "#c0392b", "#1f5fa8", "#2e8b57", "#8e44ad"]Correlation-line colours for tops, cycled in top order (contacts keep their contact colour).
styles.zoneTintslist["#d6c496", "#facd78", "#aacdeb", "#c8e1af", "#e1bed2"]Cross-section zone tints for zones without a lithology, cycled.
styles.trajectoryColorsmap{"Inclination": "#146e3c", "Azimuth": "#783caa", "Dogleg": "#d27814"}Trajectory track colours (Inclination, Azimuth, Dogleg).
styles.leakPathColorsmap{"Source": "#ffe0b2", "Sink": "#c8e6ff", "Highlight": "#ff5050"}Leak-path diagram colours (Source, Sink, Highlight).
styles.imagePalettelist[{"at": 0, "color": "#000000"}, {"at": 0.25, "color": "#5a280a"}, {"at": 0.5, "color": "#be6414"}, {"at": 0.75, "color": "#f5be3c"}, {"at…Borehole image palette: colour stops from 0 (low) to 1 (high); default 'heated'.
logs - Log curve families, styles and log validation thresholds.
logs.familieslist[{"name": "Gamma Ray", "order": 0, "match": {"contains": ["GR", "GAMMA", "SGR", "CGR"], "startsWith": [], "exact": ["SP", "NGT", "VSH"], …Curve families (tracks) and the mnemonics that belong to them; first match wins; unmatched curves go to FallbackFamily.
logs.mnemonicAliasesmap{}Other names for mnemonics (e.g. Russian ГК -> GR): grouped and styled as the canonical mnemonic; not used as petrophysics inputs.
logs.imageBoreholeDiametermeasure{"value": 8.5, "unit": "in"}Hole size assumed for image logs (dip sinusoid amplitude) when the image does not give its own.
logs.fallbackFamilystring"Other"Family for curves matching no rule.
logs.fallbackOrderint5Order of the fallback family.
logs.styleslist[{"match": {"contains": ["GR", "GAMMA"], "startsWith": [], "exact": [], "family": null}, "color": "#009688", "brush": "gamma_ray", "scale…Curve styles; first matching rule wins.
logs.maxClippedFractiondouble0.2Validation: fraction of values outside the scale above which a curve is flagged (WL009).
logs.gapFactordouble10Validation: a depth step larger than this multiple of the median step is a data gap (WL008).
loaders - File loader settings.
loaders.lasIndexMnemonicslist["DEPT", "DEPTH", "MD", "TVD", "TVDSS"]LAS index curve mnemonics, in priority order.
loaders.lasDefaultNulldouble-999.25LAS null value when the file does not declare NULL.
loaders.nullValueslist[-999.25]Curve sample values meaning no data (log tracks, checks, DLIS default; LAS files use their declared NULL).
survey - Survey quality control.
survey.toolModelstring"MWD+SRGM"Survey tool error model used for position uncertainty (a key of survey.toolModels; default the OWSG standard MWD model MWD+SRGM, A001Mc).
survey.toolModelsmap{"ISCWSA MWD Rev5": {"name": "ISCWSA MWD Rev5", "source": "ISCWSA MWD (Fixed Rig) Rev 5 model table (same as OWSG MWD Rev 2), from the IS…Survey tool error models by name (built in: ISCWSA MWD Rev5 and 53 OWSG Tool Group A Rev 5.1 models); add your own.
survey.workingNorthstring"Grid"North that trajectories, maps and sections work in (Grid or True); survey azimuths are corrected to it.
survey.gridConvergencePositiveEastbooltrueGrid convergence sign: true = positive when grid north is east of true north (grid azimuth = true azimuth - convergence).
survey.doglegWarningdouble15Dogleg severity above which a survey station is flagged, in deg per survey.doglegCourseLength (WV013).
survey.doglegCourseLengthmeasurenullCourse length dogleg severity is expressed per (none: 100 ft / 30 m; Russia / CIS: 10 m).
survey.uncertainty.sigmadouble2Confidence multiplier of the ellipses (2 = two standard deviations).
survey.uncertainty.ellipseCountint10Most ellipses drawn along a path; drawn at survey stations (where the uncertainty is defined), evenly spread.
survey.uncertainty.sourceslist[{"code": "DRF", "description": "Depth reference", "mode": "random", "magnitude": 0.35, "unit": "m", "weight": "depth"}, {"code": "DSF", …Error sources (default: simplified MWD subset in the ISCWSA structure; use your tool model's values).
barriers - Well barriers.
barriers.requiredBarriersint2Barriers required on every leak path (two-barrier principle).
barriers.countImpairedboolfalseCount impaired elements as barriers in leak-path analysis.
barriers.acceptanceReferencesmap{"FLUID_COLUMN": "NORSOK D-010 Rev 3 Table 1", "CASING": "NORSOK D-010 Rev 3 Table 2", "DRILLING_BOP": "NORSOK D-010 Rev 3 Table 4", "WEL…Acceptance-criteria reference per WBE type (standard + table). Defaults: only NORSOK D-010 Rev 3 tables verified; set your revision / company standard.
annuli - Annuli / MAASP screening.
annuli.burstDeratingdouble0.8MAASP screening: derating applied to the outer casing burst rating (0-1).
annuli.collapseDeratingdouble1MAASP screening: derating applied to the inner string collapse rating (0-1).
pressure - Formation pressure analysis.
pressure.gasOilBoundarymeasure{"value": 0.2, "unit": "psi/ft"}Gradient below which a fluid is typed as gas.
pressure.oilWaterBoundarymeasure{"value": 0.4, "unit": "psi/ft"}Gradient at or above which a fluid is typed as water.
pressure.minGradientContrastmeasure{"value": 0.05, "unit": "psi/ft"}Automatic zoning: minimum gradient difference between adjacent zones.
pressure.splitImprovementdouble0.5Automatic zoning: a further split must reduce the squared error by at least this fraction.
pressure.maxZonesint3Automatic zoning: maximum number of fluid zones.
pressure.minPointsPerZoneint3Automatic zoning: minimum tests per zone.
pressure.maxRmsResidualmeasure{"value": 3, "unit": "psi"}Gradient fit RMS residual above which a fit is flagged (WL031).
gasRatios - Mud-gas ratio interpretation.
gasRatios.veryDryGasWetnessdouble0.5Haworth: wetness (Wh) below this is very dry gas.
gasRatios.gasWetnessMaxdouble17.5Haworth: upper wetness of the gas band.
gasRatios.oilWetnessMaxdouble40Haworth: upper wetness of the oil band (above: residual oil).
gasRatios.characterOilThresholddouble0.5Haworth: character (Ch) at or above which gas is associated with oil.
gasRatios.minShowGasdouble1000Minimum total gas for ratios to be interpreted (below: background).
cement - Cement bond evaluation.
cement.freePipeAmplitudefloat62CBL amplitude in free pipe (mV) — replace with your tool / casing calibration.
cement.bondedAmplitudefloat2CBL amplitude at 100 % bond (mV).
cement.amplitudeUnitstring"mV"Unit of freePipeAmplitude / bondedAmplitude (mV); CBL curves in another voltage unit are converted.
cement.goodBondIndexfloat0.8Bond index at or above which bond is good.
cement.poorBondIndexfloat0.3Bond index below which bond is poor.
cement.minIsolationLengthmeasure{"value": 10, "unit": "ft"}Continuous good bond required for a cement barrier element to be verified.
cement.minCoveragedouble0.5Minimum fraction of a cement element that must be logged to verify it.
history - Well history comparison.
history.matchTolerancemeasure{"value": 200, "unit": "ft"}State comparison: items of the same type within this distance are the same item.
history.stringMatchFactordouble5State comparison: tolerance multiplier for strings (long objects).
validation - Other validation thresholds.
validation.cuttingsTotalTolerancedouble5Cuttings: allowed deviation of a sample's lithology total from 100 % (WL070).
correlation - Correlation panels.
correlation.wellGapfloat70Gap between wells (px).
correlation.showWellheadsboolfalseShow wellhead stacks above the plots.
correlation.referencestring"TVDSS"Default vertical reference: MD, TVD or TVDSS.
crossSection - Cross-sections.
crossSection.maxOffsetdouble0Flag wells farther than this from the section line (0 = no limit), in the panel unit.
crossSection.verticalExaggerationfloatnullFixed vertical exaggeration; null = fit the panel.
printing - Printing and export.
printing.papersmap{"A4": {"width": 595.28, "height": 841.89}, "A3": {"width": 841.89, "height": 1190.55}, "Letter": {"width": 612, "height": 792}, "Tabloid…Paper sizes by name in points (portrait); add your own.
printing.paperstring"A4"Paper: a name from printing.papers (A4, A3, Letter, Tabloid or your own).
printing.landscapeboolfalseLandscape orientation.
printing.marginfloat28Page margin (pt).
printing.scaleRatiofloat500Depth scale 1:N (0 = fit to page).
printing.includeHeaderBlockbooltruePrint the well header block on page 1.
printing.headerBlockHeightfloat118Header block height (pt).
printing.includeLegendbooltruePrint the legend.
printing.footerHeightfloat16Footer height (pt).
printing.dpifloat150Raster export resolution (dpi).
printing.headerFieldsmap{}Extra header-block fields (label -> value), e.g. company, rig, revision.
printing.footerLeftstring"{well} · {reference} {range} · scale {scale}"Left footer text. Tokens: {well}, {title}, {reference}, {range}, {scale}, {page}, {pages}, {date}.
printing.footerRightstring"page {page} / {pages}"Right footer text (same tokens).
printing.templatesmap{}Named page templates (for example "a3-log"): each changes only the settings it names.
live - Real-time display.
live.staleAfterSecondsdouble120Seconds without new data before a live feed is shown as STALE.
live.witsmlTimeoutSecondsdouble30Seconds allowed for one WITSML store request (raise for slow links, e.g. satellite).
live.witsmlRetriesint3WITSML retries after a transient failure (network error, timeout, HTTP 5xx).
live.witsmlRetryDelaySecondsdouble1Seconds before the first WITSML retry; doubled for each further retry.
live.followSpanfloat200Depth span shown in follow mode (axis units).
imageLogs - Borehole image logs.
imageLogs.normalizationstring"Dynamic"Default normalization: Static or Dynamic.
imageLogs.dynamicWindowmeasure{"value": 6, "unit": "ft"}Dynamic normalization window.
imageLogs.levelsint16Colour levels.
dataSourcesmap{}The company's data sources by name, with their profile overrides (code values, row filters).
locale - How numbers and dates look on screen (files stay invariant).
locale.culturestring""Culture for numbers on screen (for example de-DE: decimal comma); empty: invariant. Files are never affected.
locale.dateFormatstring"yyyy-MM-dd"Date pattern on screen (.NET custom format, for example dd.MM.yyyy); empty: the culture's short date.
locale.dateTimeFormatstring"yyyy-MM-dd HH:mm"Date and time pattern on screen; empty: the culture's short date and time.
locale.timeZonestring""Time zone for displayed and printed times (IANA or Windows id, e.g. UTC, Europe/Oslo, America/Denver); empty: the machine's own.
locale.calendarstring"Gregorian"Calendar of dates on screen: Gregorian (default) or Culture (the culture's own, e.g. Hijri for ar-SA).
dips - Conventions of dip picks that do not state their own.
dips.framestring"True"Frame of dip angles: True or BoreholeRelative.
dips.azimuthReferencestring"North"What dip azimuths are measured from: North or HighSide.
dips.northReferencestringnullNorth of north-referenced dip azimuths: True, Grid or Magnetic; none: the well's survey north.
conversion - Model-to-view conversion defaults.
conversion.depthModestring"Compressed"Depth scale of converted views: True or Compressed.
conversion.dimensioningstring"Scaled"Schematic dimensioning: Scaled (real diameters) or Schematic.
conversion.installedOnlybooltrueShow only installed items (not removed / abandoned).
conversion.addCasingShoesbooltrueAdd casing shoes at string bottoms.
conversion.labelComponentsbooltrueLabel components with their names.
conversion.generateBarriersboolfalseGenerate a typical barrier set when the source has none (marked Planned).
conversion.generateAnnuliboolfalseIdentify annuli from strings when the source has none.
conversion.showTrajectorybooltrueAdd a deviation track when a survey exists.
conversion.showBarrierTablebooltrueAdd the barrier / integrity table when barrier or annulus data exists.
petrophysics - Computed petrophysical curves (shale volume, porosity, water saturation).
petrophysics.grCleandouble20Gamma ray of clean formation (API) - shale volume.
petrophysics.grShaledouble120Gamma ray of shale (API) - shale volume.
petrophysics.grUnitstring"gAPI"Unit of grClean / grShale (gAPI; uR/h for Russian / CIS gamma-ray logs).
petrophysics.cutoffs.vshMaxdoublenullMaximum shale volume (v/v) of net reservoir.
petrophysics.cutoffs.porosityMindoublenullMinimum porosity (v/v) of net reservoir.
petrophysics.cutoffs.swMaxdoublenullMaximum water saturation (v/v) of net pay.
petrophysics.zoneCutoffsmap{}Cutoffs per zone (formation name), overriding cutoffs field by field.
petrophysics.vshMethodstring"Linear"Shale volume from the gamma-ray index: Linear, LarionovTertiary, LarionovOlder, Clavier or Steiber.
petrophysics.matrixDensitymeasure{"value": 2.65, "unit": "g/cm3"}Matrix density (sandstone 2.65, limestone 2.71, dolomite 2.87 g/cm3).
petrophysics.fluidDensitymeasure{"value": 1, "unit": "g/cm3"}Pore fluid density (fresh water 1.0, salt mud filtrate about 1.1 g/cm3).
petrophysics.densityNeutronMethodstring"Average"Density-neutron combination: Average or RootMeanSquare (gas zones).
petrophysics.archieAdouble1Archie tortuosity factor a.
petrophysics.archieMdouble2Archie cementation exponent m.
petrophysics.archieNdouble2Archie saturation exponent n.
petrophysics.rwdouble0.05Formation water resistivity Rw at formation temperature (ohm.m).
petrophysics.inputsmap{"gammaRay": "GR", "density": "RHOB", "neutron": "NPHI", "resistivity": "RT", "porosity": "PHIT"}Input curve mnemonics (after the curve-mnemonic vocabulary): gammaRay, density, neutron, resistivity.
antiCollision - Anti-collision: ISCWSA separation rule parameters and levels.
antiCollision.scalingFactordouble3.5Dimensionless scaling factor k (SPE-187073: 3.5).
antiCollision.surfaceMarginmeasure{"value": 0.3, "unit": "m"}Surface margin Sm (SPE-187073: 0.3 m).
antiCollision.projectAheadmeasure{"value": 0.5, "unit": "m"}Project-ahead uncertainty, 1 sigma (SPE-187073: 0.5 m).
antiCollision.scanStepmeasure{"value": 10, "unit": "m"}MD step of the reference-well scan.
antiCollision.geomagneticCorrelationbooltrueCorrect for geomagnetic reference errors shared by both wells (ISCWSA technical supplement on partial correlations).
antiCollision.scanRadiusmeasure{"value": 5000, "unit": "m"}Offset wells whose wellhead is farther than this are left out.
antiCollision.levelslist[{"name": "Stop", "below": 1, "color": "#b71c1c"}, {"name": "Adjust plan", "below": 1.25, "color": "#e65100"}, {"name": "Shut in / adjust…Separation-factor levels (defaults: the ISCWSA e-book's documented operator rules).
antiCollision.offsetColorslist["#00897b", "#6a1b9a", "#ef6c00", "#2e7d32", "#ad1457", "#283593"]Colours of offset wells on the plots, in turn.
casingDesign - Casing design checks: rating method, grade yields, design factors, pipe dimensions.
casingDesign.methodstring"API 5C3"Rating method: API 5C3 (ISO/TR 10400 ductile rupture not yet implemented).
casingDesign.gradeYieldmap{"H40": 40, "J55": 55, "K55": 55, "N80": 80, "L80": 80, "C90": 90, "R95": 95, "T95": 95, "C110": 110, "P110": 110, "Q125": 125}Minimum yield strength per grade (ksi), API Spec 5CT; add your grades.
casingDesign.designFactors.burstdouble1.25Burst design factor (default 1.25, Devon Energy example, EPA workshop 2011).
casingDesign.designFactors.collapsedouble1.1Collapse design factor (default 1.1, same source).
casingDesign.designFactors.tensiondouble1.4Tension design factor (default 1.4, same source).
casingDesign.pipeDimensionslist[{"outerDiameter": 9.625, "weight": 32.3, "wall": 0.312}, {"outerDiameter": 9.625, "weight": 36, "wall": 0.352}, {"outerDiameter": 9.625,…Nominal weight -> wall thickness (in, lb/ft, in) for strings without an inside diameter.
casingDesign.steelDensitymeasure{"value": 7.85, "unit": "g/cm3"}Steel density for buoyancy (carbon steel 7.85 g/cm3).
osdu - OSDU export: data partition, ACL groups, legal tags, countries.
osdu.dataPartitionstring""Data partition id: the namespace of record and reference-data ids (e.g. opendes).
osdu.viewerslist[]ACL viewer groups (e.g. data.default.viewers@opendes.yourcompany.com).
osdu.ownerslist[]ACL owner groups.
osdu.legalTagslist[]Legal tags of the records.
osdu.countrieslist[]Other relevant data countries (ISO 3166 two-letter); none: the environment's country.
toolboxesmap{}Settings of toolboxes (well integrity, drilling, production, data and AI, training, or your own), one object per toolbox.
abandonment - Permanent plug and abandonment checks.
abandonment.ruleSetstringnullRule set in effect: a key of abandonment.ruleSets; empty = the values of this section (the default rule set, NORSOK D-010).
abandonment.environmentalPlugDepthFromstring"datum"For this section's rule set: what the environmental plug depth is measured from (datum as before, or surface).
abandonment.ruleSetsmap{"US-BSEE": {"name": "US offshore (BSEE, 30 CFR 250.1715)", "reference": "30 CFR 250.1715 - How must I permanently plug a well?", "status…Other named rule sets; built in: US-BSEE (30 CFR 250.1715), UK-OEUK (OEUK guidelines), RU (Rostekhnadzor order No. 534); add your own.
abandonment.minPlugLengthmeasure{"value": 100, "unit": "m"}Minimum cement plug length (NORSOK D-010 rev. 5: 100 m MD; open hole: at least 50 m MD above any source of inflow).
abandonment.foundationPlugLengthmeasure{"value": 50, "unit": "m"}Minimum plug length when set on a mechanical or cement foundation (NORSOK D-010 rev. 5, cased hole: 50 m MD).
abandonment.foundationTolerancemeasure{"value": 5, "unit": "m"}A foundation counts when its top is within this distance of the plug base.
abandonment.environmentalPlugMaxDepthmeasure{"value": 50, "unit": "m"}An environmental (surface) plug must have its top shallower than this depth.
abandonment.environmentalPlugMinLengthmeasure{"value": 100, "unit": "m"}Minimum length of the environmental (surface) plug (NORSOK D-010 rev. 5: 100 m MD; on a mechanical plug see environmentalPlugFoundationLength).
abandonment.environmentalPlugFoundationLengthmeasure{"value": 50, "unit": "m"}Minimum length of the environmental plug when set on a mechanical plug (NORSOK D-010 rev. 5: 50 m MD).
abandonment.sourceTypeslist["PERFORATION", "OPEN_HOLE"]Interval / component types treated as sources of inflow (plus open hole).
abandonment.referencestring"NORSOK D-010:2021+AC:2024 (rev. 5)"Standard referenced by the checks (shown in the checklist).
map - Well map (plan view).
map.wellColorstring"#263238"Well surface location marker colour.
map.pathColorstring"#1f5fa8"Plan-view well path colour.
map.sectionLineColorstring"#d81b60"Section line colour.
map.showGridbooltrueDraw a coordinate grid.
map.pickRadiusfloat10Pixel radius within which a click selects a well.
crossplots - Crossplots (density-neutron, Pickett).
crossplots.densityNeutronLineslist[{"name": "Sandstone", "matrixDensity": 2.65, "neutronAtMatrix": -0.035, "color": "#c9a227"}, {"name": "Limestone", "matrixDensity": 2.71…Density-neutron lithology lines. Limestone is exact for a limestone-calibrated neutron; sandstone and dolomite offsets are approximate defaults - replace them with your tool's chart values.
crossplots.pickettSwLineslist[1, 0.5, 0.25]Water saturations drawn as Pickett lines (fractions).
crossplots.pickettRtRangelist[0.1, 1000]Pickett resistivity axis [min, max] (ohm.m, logarithmic); points outside are reported.
crossplots.pickettPorosityRangelist[0.01, 1]Pickett porosity axis [min, max] (v/v, logarithmic).
crossplots.densityNeutronNeutronRangelist[-0.05, 0.45]Density-neutron neutron axis [min, max] (v/v, limestone units).
crossplots.densityNeutronDensityRangelist[1.95, 2.95]Density-neutron density axis [min, max] (g/cm3).
crossplots.pointSizefloat2.5Point radius (px).
crossplots.pointColorstring"#37474f"Colour of points without zone or colour curve.
crossplots.rampLowstring"#2e7d32"Colour-curve ramp, low end.
crossplots.pickettWaterLinestring"#1565c0"Pickett plot: colour of the Sw = 1 (water) line.
crossplots.pickettSwLinestring"#78909c"Pickett plot: colour of the other Sw lines.
crossplots.rampHighstring"#c62828"Colour-curve ramp, high end.
verification - Reference cases run by wellbore-config verify.
verification.caseslist[{"name": "foot to metre (exact)", "kind": "unit", "tolerance": 1e-12, "value": 1, "expected": 0.3048, "from": "ft", "to": "m", "survey":…Reference cases run by wellbore-config verify; the built-in ones have exact or closed-form answers.
schematic - Schematic layout geometry (host slot radii).
schematic.rolesmap{"tubing": {"componentTypes": [], "symbols": ["str_tubing"], "symbolPrefixes": [], "excludeSymbols": []}, "productionCasing": {"component…Symbol roles (tubing, packer, safety valve, wellhead, cement plug...): component types, symbols, prefixes, exclusions.
schematic.hostFamiliesmap{"tubing": "tubing", "tubing_in_casing": "tubing", "tubing_in_open_hole": "tubing", "dual_tubing_in_casing": "tubing", "liner_in_casing":…How each host slot is drawn: tubing, linerInCasing, liner or casing.
schematic.overlayReachfloat24How far an overlay reaches outward from its slot (symbol units).
schematic.hostRadiimap{"tubing": 9, "tubing_in_casing": 9, "tubing_in_open_hole": 9, "casing": 24, "liner": 17, "lower_completion": 17, "liner_in_casing": 17, …Radius of each equipment host slot (symbol units).
tubulars - Tubular catalogue (casing and tubing sizes, grades, connections) of the standard in use.
tubulars.standardstring"API 5CT / ISO 11960"Standard the catalogue follows (information).
tubulars.sizeUnitstring"in"Unit of the sizes (in or mm).
tubulars.casingSizeslist["4 1/2", "5", "5 1/2", "6 5/8", "7", "7 5/8", "7 3/4", "8 5/8", "9 5/8", "10 3/4", "11 3/4", "13 3/8", "16", "18 5/8", "20"]Casing outside diameters.
tubulars.tubingSizeslist["1.050", "1.315", "1.660", "1.900", "2 3/8", "2 7/8", "3 1/2", "4", "4 1/2"]Tubing outside diameters.
tubulars.gradeslist["H40", "J55", "K55", "N80", "N80-1", "N80Q", "L80", "L80-1", "L80-9Cr", "L80-13Cr", "C90", "R95", "T95", "C110", "P110", "Q125"]Steel grades / strength groups.
tubulars.connectionslist["STC", "LTC", "BTC", "NUE", "EUE", "Premium"]Connection types.
tubulars.notesstringnullNotes (edition followed, other standards in use).
region - The country or region the environment is for.
region.wellIdentifierslist[]Well identifier formats of the country; a well's identifier must match one (WI001). Empty: not checked.
region.coordinateSystemslist[]Coordinate systems commonly used in the country (information; confirm with your survey department).
region.countrystringnullISO 3166 two-letter country code (for example US, RU, NO).
region.namestringnullCountry or region name.
region.regulatorslist[]Regulators and standards commonly referred to there (information).
region.notesstringnullNotes on the preset (what is typical practice and should be confirmed).
files - Reading text files: legacy code page.
files.legacyEncodingstring"windows-1252"Code page for text files that are neither marked (BOM) nor valid UTF-8: windows-1252, windows-1251, cp866, gbk, shift_jis, windows-1256...
files.encodingAliasesmap{"cp1251": "windows-1251", "cp1252": "windows-1252", "cp1256": "windows-1256", "utf8": "utf-8", "latin1": "iso-8859-1", "sjis": "shift_jis"}Other names for encodings (cp1251 -> windows-1251...).
equipment - Equipment attribute rules and completion tally columns.
equipment.attributesmap{"*": [{"key": "manufacturer", "label": "Manufacturer", "kind": "text", "unit": null, "required": false, "choices": null, "min": null, "m…Attribute rules by component type ("*" = all types, "PACKER_*" = prefix).
equipment.programColumnslist[{"key": "no", "header": "#"}, {"key": "name", "header": "String"}, {"key": "top", "header": "Top"}, {"key": "bottom", "header": "Bottom"…Casing and tubing program columns, in order.
equipment.programExcludedSymbolslist["str_control_line"]String symbols left out of the casing and tubing program.
equipment.tallyColumnslist[{"key": "no", "header": "#"}, {"key": "name", "header": "Component"}, {"key": "type", "header": "Type"}, {"key": "top", "header": "Top"}…Completion tally columns, in order.
branding - Trademark footnote and logo on exports, prints and views.
branding.footnotestring"The Tech Idea™"Trademark footnote on every export, print and view.
branding.logoFilestringnullLogo file drawn before the footnote (PNG or JPEG, relative to the environment file); null = the built-in The Tech Idea logo.
branding.showLogobooltrueDraw a logo before the footnote.
branding.showInExportsbooltrueShow the footnote in PDF / SVG / PNG exports and prints.
branding.showOnScreenbooltrueShow the footnote in the corner of interactive views.
resources - External files overriding built-in resources (paths relative to this file).
resources.lithologyFilestringnullLithology library JSON (replaces the built-in library).
resources.lithologyStandardslist[]National lithology standards layered on the library: GOST 21.302-2013 (built in) or a standard JSON file; FGDC is built into the library.
resources.toolModelFileslist[]Survey tool error models as ISCWSA error-model JSON files; they join survey.toolModels by model name.
resources.standardLexiconslist["ICS"]Published stratigraphic standards layered under the lexicon files (built in: ICS); empty: none.
resources.symbolCatalogFilestringnullSymbol catalog JSON (replaces the built-in catalog).
resources.componentSymbolsFilestringnullComponent type -> symbol JSON (same format as the built-in component-symbols.json).
resources.geomagneticModelFilestringnullGeomagnetic model coefficient file in NOAA .COF format; none: the embedded WMM2025.
resources.barrierTemplateFileslist[]Barrier template files merged over the built-in templates by name.
resources.leakPathFileslist[]Leak-path network files merged over the built-in networks by name (their selection rules first).
resources.modelCatalogFileslist[]Model catalog files (component, barrier element and fluid contact types) merged over the built-in catalog by code.
resources.countryFolderslist[]Folders with company country environments (<CODE>.json); "country:XX" looks here before the built-in countries.
resources.vocabularyFileslist[]Code vocabulary files (source codes -> canonical), first match wins.
resources.lexiconFileslist[]Stratigraphic lexicon files (local layer names -> canonical units).
resources.labelFileslist[]UI label files (per culture / company).
resources.mappingProfilesFolderstringnullFolder searched for data-source mapping profiles (<name>.profile.json) before the built-in ones.