TheTechIdea OilGas - developer guide
The wellbore family draws professional well views - completion schematics, well logs, well integrity, correlation panels and cross-sections - on one shared depth axis, so a log and a schematic line up exactly like in dedicated well software. Everything a customer may need to change (units, criteria, names, colours, mappings) is configuration, not code.
| Library | Role |
|---|---|
TheTechIdea.OilGas.Wellbore.Data |
Canonical well model, units, trajectories, barriers, pressure, mud log; the environment and the configuration contracts. Pure .NET. |
TheTechIdea.OilGas.Wellbore.Loaders |
LAS 2.0 / 3.0, WITSML 1.3.1.1 / 1.4.1.1 / 2.0 (including live logs), tabular sources (CSV, PPDM, your database) through mapping profiles. Pure .NET. |
TheTechIdea.OilGas.Wellbore |
Shared drawing layer: depth axis and mapping (MD / TVD / TVDSS, compressed depth), tracks, canvas, correlation, cross-section, printing, validation. |
TheTechIdea.OilGas.WellLogs |
Log family: curves, lithology, pressure, dips, borehole images, cement bond (CBL / VDL), mud log, live feeds. |
TheTechIdea.OilGas.WellSchematic |
Schematic family: completion schematic, tally, barriers, annuli / MAASP, leak paths, planned vs as built, well path. |
Your first well view
// Application start-up: load the customer's environment once (in an app: WellboreServices.Global = ...).
// Here it is scoped by the caller; see the multi-tenant scenario.
// 1. Load a well through a mapping profile (the environment's profile folder is searched first).
var provider = new MappedWellDataProvider(new CsvTabularSource(csvFolder), MappingProfile.Load("csv"));
WellLoadResult result = await provider.LoadWellAsync("CSV-1");
foreach (var warning in result.Warnings) Console.WriteLine("data: " + warning);
// 2. Build the view: schematic + tally + logs / pressure / core tracks from the log family.
var view = WellModelConverter.ToWellboreView(result.Model,
new WellModelConversionOptions { ExtraTracks = WellLogTracks.FromModel, GenerateBarriers = true }, out var conversionWarnings);
// 3. Host it: WellboreView draws on any SkiaSharp canvas; wire it to your UI control (see README): zoom, pan, cursor, selection, top dragging.
var canvas = new WellboreView { Document = view, Width = 1600, Height = 1000 };
canvas.View.SetRange(view.Axis, 9000, 12000); // zoom to the completion
canvas.MarkerMoved += (s, move) => Console.WriteLine($"{move.Marker.Name} moved to {move.To}");
// 4. Check the data before showing it, then export what the user sees (ToPdf, ToSvg or ToPng).
IReadOnlyList<WellboreIssue> issues = canvas.Validate();
using var pdf = new MemoryStream();
int pages = WellboreExport.ToPdf(view, pdf);
Where to go next
- Getting started - references, first view, environment file, tests, rebuilding these docs.
- Architecture - how the pieces fit, what is cached, how configuration flows.
- Scenarios -
tested usage scenarios with their code. - Configuration - the environment (
264settings) and how it is resolved. - Data sources & mapping - mapping profiles, code vocabularies, stratigraphic lexicons. - Extending - custom tracks, sources and contracts. - Validation codes - all
158codes. - API reference -
682public types.
Every code sample in this guide is a region of TheTechIdea.OilGas.Tests/ScenarioTests.cs, compiled and executed by the test suite.