Structure depth fault lines

This exports the modelled structural depth fault lines from within RMS. These fault lines are polygons that represent the intersection of a modelled stratigraphic horizon surface with the modelled fault surfaces.

Note

It is only possible to export one single set of depth fault lines per model workflow, i.e. one fault line polygon object per stratigraphic horizon.

Current

Field	Value
Version	0.1.0
Output	share/results/polygons/structure_depth_fault_lines/surfacename.parquet
Security classification	🟡 Internal

Requirements

• RMS

• depth fault line polygons stored in a horizon folder within RMS

The fault line polygons must be located within a horizon folder in RMS and be in domain depth. This export function will automatically export all non-empty polygon objects from the provided folder.

Important

These polygons should be extracted from the final depth horizon model using the Extract Fault Lines job in RMS. This will ensure that all fault polygons are closed and that the fault name is added as an attribute.

Usage

export_structure_depth_fault_lines(project, horizon_folder)

Simplified interface when exporting fault lines from RMS.

Parameters:

• project (Any) – The ‘magic’ project variable in RMS.

• horizon_folder (str) – Name of horizon folder in RMS.

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_structure_depth_fault_lines

export_results = export_structure_depth_fault_lines(
    project, "DL_faultlines"
)

for result in export_results.items:
    print(f"Output fault line polygons to {result.absolute_path}")

Result

Given a stratigraphic horizon name TopVolantis the result file will be share/results/polygons/structure_depth_fault_lines/topvolantis.parquet.

This is a tabular file on .parquet format. It contains the following columns with types validated as indicated.

Standard result schema

This standard result is made available with a validation schema that can be used by consumers. A reference to the URL where this schema is located is present within the data.standard_result key in its associated object metadata.

Field	Value
Version	0.1.0
Filename	structure_depth_fault_lines.json
Path	schemas/file_formats/0.1.0/structure_depth_fault_lines.json
Prod URL	https://main-fmu-schemas-prod.radix.equinor.com/schemas/file_formats/0.1.0/structure_depth_fault_lines.json 🔒
Dev URL	https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/structure_depth_fault_lines.json 🔒

JSON schema

The current JSON schema is embedded here.

{
  "$defs": {
    "StructureDepthFaultLinesResultRow": {
      "description": "Represents the columns of a row in a structure depth fault lines export.\n\nThese fields are the current agreed upon standard result. Changes to the fields or\ntheir validation should cause the version defined in the standard result schema to\nincrease the version number in a way that corresponds to the schema versioning\nspecification (i.e. they are a patch, minor, or major change).",
      "properties": {
        "NAME": {
          "title": "Name",
          "type": "string"
        },
        "POLY_ID": {
          "minimum": 0,
          "title": "Poly Id",
          "type": "integer"
        },
        "X_UTME": {
          "title": "X Utme",
          "type": "number"
        },
        "Y_UTMN": {
          "title": "Y Utmn",
          "type": "number"
        },
        "Z_TVDSS": {
          "title": "Z Tvdss",
          "type": "number"
        }
      },
      "required": [
        "X_UTME",
        "Y_UTMN",
        "Z_TVDSS",
        "POLY_ID",
        "NAME"
      ],
      "title": "StructureDepthFaultLinesResultRow",
      "type": "object"
    }
  },
  "$id": "https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/structure_depth_fault_lines.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Represents the resultant structure depth fault lines parquet file, which is\nnaturally a list of rows.\n\nConsumers who retrieve this parquet file must read it into a json-dictionary\nequivalent format to validate it against the schema.",
  "items": {
    "$ref": "#/$defs/StructureDepthFaultLinesResultRow"
  },
  "title": "StructureDepthFaultLinesResult",
  "type": "array",
  "version": "0.1.0"
}