TheTechIdea OilGas - Developer guide User guide →

Configuration

All customer-adjustable values live in one model, WellboreEnvironment, loadable from JSON per customer, country or tenant.

What is configurable - and what is not

Configurable: units, standards references, engineering thresholds and criteria, classification rules, colours and styles, print, live, correlation and conversion defaults, and paths to your own lexicons, vocabularies, labels, symbol maps and mapping profiles.

Not configurable, by design: physical constants and unit definitions (0.3048 m/ft, 0.052 psi/ft per ppg, the US survey foot), algorithm internals (iteration counts, tolerances) and pure drawing geometry. A typo in a JSON file must never change physics.

The file

Downloads: template with every key - JSON Schema - samples.

Loading and scoping

// Desktop / single customer
WellboreServices.Global = WellboreServices.Load(path);

// Server: per request / tenant
using (WellboreServices.Scope(servicesOfThisCustomer)) { ... }

// Tests: temporary overrides
using (WellboreServices.Scope(WellboreEnvironment.FromJson(@"{ ""barriers"": { ""requiredBarriers"": 3 } }"))) { ... }

WellboreServices.Warnings lists unknown keys, invalid values and missing resource files. Nothing throws for a bad file except a schema version newer than the library supports.

When values are read

Company base and overlays (extends)

An environment can extend one or more base files - typically a company base, then a country or asset overlay:

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

Theme presets

theme.preset: light (default), dark, print or highContrast. Explicit theme keys still win over the preset. Validate() flags text / background contrast below 4.5:1 (WCAG AA); the highContrast preset reaches at least 7:1.

Checking resource files

Lexicons, vocabularies and labels are checked when they load; problems are listed in WellboreServices.Issues (with the file) and in Warnings, with the WR codes of the validation catalog. A lexicon name claimed by two units is reported and resolves to the first one - it is never overwritten silently.

wellbore-config (command line)

wellbore-config validate acme-kw.environment.json     # exit 0 clean, 1 warnings, 2 errors - use it in CI
wellbore-config show acme-kw.environment.json cement  # effective values with their source
wellbore-config diff ncs.environment.json kw.environment.json
wellbore-config template environment.template.json
wellbore-config schema environment.schema.json
wellbore-config save environment.json saved-configuration
wellbore-config verify acme-kw.environment.json        # reference cases and cross-checks - use it in CI
wellbore-config where                                  # where every configuration, sample and generator is, and the command that writes each
wellbore-config samples kuwait.environment.sample.json kw.json   # a sample, a mapping profile or a country environment, as a file
wellbore-config samples --all starter                  # everything, in the layout of the published downloads

Install from the repository (tools/config-cli) or as the TheTechIdea.OilGas.ConfigTool .NET tool.

Finding the configuration resources from code

ConfigurationResources (TheTechIdea.OilGas.Wellbore.Loaders) is the one place that knows where each configuration resource is - the environment template and schema, the country environments, the samples and the built-in mapping profiles - and is what where and samples print and write. ConfigurationResources.All lists them; each ConfigurationResource has a Name (a file name, country:KW, profile:csv), a Kind, a Description, what holds it (Where), the command that writes it, its path in the source repository (SourceTreePath) and in the published site (DocsPath), and Read(). Find(name) takes any of those names, a bare country code or a bare profile name; Export(folder) writes them in the layout of the published downloads and refuses to overwrite unless told to; Describe(folder) is the text of wellbore-config where, and says which parts of a source checkout are missing. The samples are embedded in the library, so they reach a host that has no source tree. A test keeps the catalogue equal to the files: a sample that is not embedded and described, a path that has moved, or a download that was not published fails it.

Recipes

Each recipe is backed by a test that keeps it working.

Recipe How Proven by
Company base + country overlay extends the company file; list only what the country changes Phase1Tests.Inheritance_OverlayWinsMapsMergeListsReplacePathsRebase
Country layer names a lexicon in resources.lexiconFiles, culture for display names MappingTests.Tops_ResolveToUnitsAndShowTheCultureName
Your PPDM flavour <name>.profile.json in resources.mappingProfilesFolder MappingTests.Profiles_EnvironmentFolderBeforeBuiltIn
SI units units.depthUnit: "m", units.pressureUnit: "bar" Phase0Tests.Pressures_DisplayInTheEnvironmentUnit
Company wording a labels file in resources.labelFiles Phase0Tests.Labels_ChangeWhatUsersSee
Dark or high-contrast screens theme.preset Phase1Tests.ThemePresets_ApplyUnderExplicitKeysAndMeetContrast

Contracts a host can replace

WellboreServices holds every service behind a contract: Vocabulary (ICodeVocabulary), Lexicon (IStratigraphicLexicon), Symbols (ISymbolResolver), Curves (ICurveClassifier), Labels (ILabelProvider), UnitCatalog (IUnitCatalog), Countries (ICountryCatalog) and ModelCatalog (IModelCatalog: component, barrier element and fluid contact types). Defaults come from the environment and the built-in data; set any of them to take that part from your own system (for example units from a company database), for the whole process (WellboreServices.Global) or one request (WellboreServices.Scope). The static helpers - Units.Convert, CountryPresets - go through the current services, so existing code follows. An environment is always validated against its own definitions.

using (WellboreServices.Scope(new WellboreServices(environment) { UnitCatalog = myUnits, Countries = myCountries }))
{
    var ok = Units.Convert(1, "furlong", "m");      // resolved by myUnits
}

Deterministic runs

Every new record id and every time stamp (audit entries, provenance, annotations, print date) comes from the services: Ids (IIdGenerator, default random GUIDs) and Clock (IClock, default the system clock). For tests, reproducible reports or lockstep hosts, set deterministic ones - the same inputs then give the same bytes:

var services = new WellboreServices(environment)
{
    Ids = new SequentialIdGenerator("w"),                              // w000001, w000002...
    Clock = new FixedClock(new DateTime(2026, 1, 1, 0, 0, 0, DateTimeKind.Utc))
};
using (WellboreServices.Scope(services)) { /* load, convert, build barrier sets... */ }

Barrier element ids are derived from their envelope, type and target (Primary-CASING_CEMENT-PROD), so building the same set twice gives the same ids with any generator; documents saved with the earlier random ids still load.

Load and save: IJsonPersistable

Every configurable part reads JSON (FromJson) and saves it (ToJson, the IJsonPersistable contract): the environment, symbol catalogue, lithology library, component-symbol map, mapping profiles, labels, vocabularies, lexicons, well models and views. Load -> save -> load gives the same part; fields a part does not interpret (for example extra keys in a company symbol catalogue) are kept. A test fails when a public type can load JSON but not save it.

WellborePrintOptions.FromTemplate("a3-log") builds print options from printing.templates (defaults, then what the template sets); TemplateNames lists them. Footer texts expand tokens with PrintTokens.Expand. PanelExport.ToPdf prints correlation panels (exact scale, CorrelationPages gives the depth windows) and cross-sections. Branding draws the trademark footnote (branding section) on every export page and - through ViewSurface.Draw - in the corner of every view.

UI labels

Texts shown to users go through ILabelProvider (UiText.Get(key, fallback)); list files in resources.labelFiles ({ "culture": "nb-NO", "labels": { "track.depth": "Dybde" } }). Keys without an entry keep the built-in text below. Validation messages are not labels: they carry stable codes (see Validation codes).

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

Full reference

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.