Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Architecture decision records

Short records of decisions that shape this library and the reasons behind them. Each one has three parts: Context (what forced a choice), Decision (what was chosen) and Consequences (what it costs and what it buys). They are written to be read in a minute; the code and the other pages are the detail.

A record is not edited to change its meaning. A decision that is reversed gets a new record that supersedes the old one, which keeps its text and a status line.

#Decision
0001Generated code is committed, produced by an internal tool
0002The storage trait is drawn after ETP
0003Identity: full URI internally, one door per access
0004Reading policy: ReadMode, version resolution, tolerance
0005Refuse rather than draw; FeatureNotEnabled
0006Registries rather than match
0007core has no native dependency (WebAssembly)
0008Inheritance and xsd:list
0009Properties, tables and colours: one colour rule
0010The package index and caches
0011Tests follow the specification, not a corpus; triangulation; a test must be able to fail
0012No face (Python, CLI) carries logic
0013WITSML channels in HDF5
0014Horizons and units, attachments, business constraints
0015The section view: three stages, model.rs as contract, one drawer
0016One crate, one test binary
0017An operation is a pure function; only apply writes
0018A synthetic reference model rather than an external corpus
0019Synthetic data is flagged and sourced
0020A grid is never reprojected
0021Our own Tool trait; the MCP SDK is an adapter behind a feature
0022The kind of an edge comes from the specification, labelled; the schema facts are generated
0023The data objects held by value are listed apart, and write their own references
0024Facets are read in every version, and say whether the schema lists them
0025A logarithmic mapping places the log of the value
0026A head portion says whether the file describes it, and is in the line’s frame
0027Gaps, seams, scales and quantiles: the numbers the views share
0028One drawing for every view: draw knows no format, one display list, one rule for graduations, a PNG is always the SVG rasterised
0029A link to a table is one qualifier facet holding the uri of the table, read once; the axes of a property come from the table it names
0030Table links: a column links by key or by rank, the target decides, one key column or none; description and title are read with a warning; an empty string is a value; the rules house/table/*
0031The direction of a line at a knot is that of the interval that ends there
0032The frame of a hole is the physical one, whatever hand the placed frame has
0033A true vertical depth along a well is counted below the MD datum
0034The north of a survey and its stations: a north the file does not state is declared by the caller, the corrections the file states are applied, a rejected station is left out on declaration, a RESQML 2.0.1 deviation survey is read
0035Provenance, written completely and read from four releases: the role from the template then a named rule, input and inputFile declared, integers as integers, verbatim sources and the NWDF tables
0036Two directional properties of one quantity keep the order a layered medium expects: a warning above 5 % of the pairs under 0.95, unverifiable on an extension direction unless the caller declares it
0037A result of a view is an artefact first and is stored on demand: one operation per sort of view, the drawing is the input and the recipe is read from it, an iso-surface promoted as it was computed
0038The geosteering section: the curtain of a cube along a well, one frame and one door for placing, folds marked and gaps never bridged, declared conventions, angles found by value
0039Several values per element are written with their shape: ValueCountPerIndexableElement and LabelPerComponent, the dataset [elements, d1, ...], a scalar written as it always was
0040The members of a wellbore are walked in the domain, from the inventory and the references alone
0041A convention the file does not state is declared by the caller; a vertical without a CRS is signalled
0042What a property says of itself: dimensions reduced together, scalars for a wrong declared count, facets of 2.0.1 outside the 2.3 list, the synthetic mark, observations beside those of the values
0043The views of a package are drawn through one door, as a display list written to SVG
0044The vector arithmetic and the small plan geometry live in energyml_geostat::vector; energyml_geometry::vector re-exports it
0045Text and numbers written by hand (XML, JSON, base 64, calendar, numbers) have one copy each
0046Reading a field of a reflected object goes through one door, energyml_core::reflect::fields, with its policy for absent, blank and mistyped fields
0047A view may propose a value the file does not state, for a first drawing; a proposal is always said as one
0048Every edge has a kind: EML and PRODML by the WITSML rule, primary by default otherwise

Decisions about the ETP protocol implementation are recorded in the retp repository.