ENH: add support for faultroom data

docs/datastructure.rst

@@ -216,6 +216,8 @@ Meta export datastructure
 .. autopydantic_model:: fmu.dataio.datastructure.meta.specification.TableSpecification
   :model-show-json: false
 
-.. autopydantic_model:: fmu.dataio.datastructure.meta.specification.WellPointsDictionaryCaseSpecification
+.. autopydantic_model:: fmu.dataio.datastructure.meta.specification.FaultRoomSurfaceSpecification
   :model-show-json: false
 
+.. autopydantic_model:: fmu.dataio.datastructure.meta.specification.WellPointsDictionaryCaseSpecification
+  :model-show-json: false

schema/definitions/0.8.0/examples/surface_faultroom_data.yml

@@ -0,0 +1,169 @@
+# Example metadata for a depth surface.
+
+$schema: https://main-fmu-schemas-dev.radix.equinor.com/schemas/0.8.0/fmu_results.json
+version: "0.8.0" # including for REP and others to build logic on.
+source: fmu  # always included, and always this value if FMU made it. For quick identification for external consumers.
+
+tracklog:
+  - datetime: 2020-10-28T14:28:02
+    user:
+      id: jriv
+    event: created
+    sysinfo:
+      fmu-dataio:
+        version: 1.2.3
+      komodo: # only added when running in Komodo environment
+        version: 2023.12.05-py38
+  - datetime: 2020-10-28T14:46:14
+    user:
+      id: peesv
+    event: updated
+
+class: surface # the geojson from fault-room represents a surface (triangulated)
+
+fmu: # the fmu-block contains information directly related to the FMU context
+  model:
+    name: ff
+    revision: 21.0.0.dev
+    description:
+      - detailed description
+      - optional
+
+  workflow:
+    reference: rms/structural_model
+
+  case:
+    name: MyCaseName
+    uuid: 8bb56d60-8758-481a-89a4-6bac8561d38e
+    user:
+      id: jriv # $USER from ERT
+    description:
+      - yet other detailed description
+      - optional
+
+  iteration:
+    id: 0 # always an int, will be 0 for e.g. "pred"
+    uuid: 4b939310-34b1-4179-802c-49460bc0f799 # hash of case.uuid + iteration.id
+    name: "iter-0" # /"pred"
+    restart_from: 15ce3b84-766f-4c93-9050-b154861f9100   # fmu.iteration.uuid for another iteration
+
+  realization:
+    id: 33
+    uuid: 29a15b21-ce13-471b-9a4a-0f791552aa51
+    name: "realization-33"
+    parameters: # directly pass parameters.txt. This is potentially a lot of content, only a stub is included here.
+      SENSNAME: faultseal
+      SENSCASE: low
+      RMS_SEED: 1006
+      INIT_FILES:
+        PERM_FLUVCHAN_E1_NORM: 0.748433
+        PERM_FLUVCHAN_E21_NORM: 0.782068
+      KVKH_CHANNEL: 0.6
+      KVKH_US: 0.6
+      FAULT_SEAL_SCALING: 0.1
+      FWL_CENTRAL: 1677
+
+  context:
+    stage: realization
+
+file:
+  # the Faultroom polygons are some kind of triangulated surfaces
+  relative_path: realization-33/iter-0/share/results/maps/topvolantis_faults.geojson # case-relative
+  absolute_path: /some/absolute/path/realization-33/iter-0/share/results/maps/topvolantis_faults.geojson # case-relative
+  checksum_md5: kjhsdfvsdlfk23knerknvk23  # checksum of the file, not the data.
+  size_bytes: 132321
+
+data: # The data block describes the actual data (e.g. surface). Only present in data objects
+
+  content: depth   # white-listed and standardized
+
+  # if stratigraphic, name must match the strat column. This is the official name of this surface.
+  name: volantis_top-volantis_base
+  stratigraphic: false  # if true, this is a stratigraphic surface found in the strat column
+  offset: 0.0  # to be used if a specific horizon is represented with an offset.
+
+  stratigraphic_alias: # other stratigraphic entities this corresponds to in the strat column, e.g. Top Viking vs Top Draupne. Ref issue.
+    - SomeName Fm. 1 Top
+  alias: # other known-as names, such as name used inside RMS etc
+    - somename_fm_1_top
+    - top_somename
+
+  # tagname is flexible. The tag is intended primarily for providing uniqueness. The tagname will also be part of the outgoing file name on disk.
+  tagname: ds_extract_geogrid
+
+  # no content-specific attribute for "depth" but can come in the future
+
+  properties: # what the values actually show. List, only one for IRAP Binary surfaces. Multiple for 3d grid or multi-parameter surfaces. First is geometry.
+    - name: PropertyName
+      attribute: owc
+      is_discrete: false # to be used for discrete values in surfaces.
+      calculation: null # max/min/rms/var/maxpos/sum/etc
+
+  format: geojson
+  layout: triangulated # / cornerpoint / structured / etc
+  unit: m
+  vertical_domain: depth # / time / null
+  depth_reference: msl # / seabed / etc
+  grid_model: # Making this an object to allow for expanding in the future
+    name: MyGrid # important for data identification, also important for other data types
+  spec: # class/layout dependent, optional? Can spec be expanded to work for all data types?
+    num_triangles: 2819
+  bbox:
+    xmin: 456012.5003497944
+    xmax: 467540.52762886323
+    ymin: 5926499.999511719
+    ymax: 5939492.128326312
+    zmin: 1244.039
+    zmax: 2302.683
+  is_prediction: true # A mechanism for separating pure QC output from actual predictions
+  is_observation: true # Used for 4D data currently but also valid for other data?
+  undef_is_zero: false # Used to flag if undef should be considered 0.0 in statistics
+  description:
+    - Fault surfaces made from the FaultRoom plugin
+
+display:
+  name: Top Volantis
+  subtitle: Some subtitle
+  line:
+    show: true
+    color: black
+    style: solid
+  points:
+    show: false
+    color: null
+  contours:
+    show: true
+    color: black
+    increment: 20
+  fill:
+    show: true
+    color: black # color and colormap are mutually exclusive in practice, so clients must choose.
+    colormap: gist_earth
+    display_min: 1221.3
+    display_max: 1900.0
+
+access:
+  asset:
+    name: Drogon
+  ssdl:
+    access_level: internal
+    rep_include: true
+  classification: internal
+
+masterdata:
+  smda:
+    country:
+      - identifier: Norway
+        uuid: ad214d85-8a1d-19da-e053-c918a4889309
+    discovery:
+      - short_identifier: DROGON
+        uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon
+    field:
+      - identifier: DROGON
+        uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon
+    coordinate_system:
+      identifier: ST_WGS84_UTM37N_P32637
+      uuid: ad214d85-dac7-19da-e053-c918a4889309
+    stratigraphic_column:
+      identifier: DROGON_2020
+      uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon