Clean up and improve metadata examples (#224)

Clean up and improve metadata examples
equinor · Sep 16, 2022 · ebf4b72 · ebf4b72
1 parent 50a6d9f
commit ebf4b72
Show file tree

Hide file tree

Showing 7 changed files with 275 additions and 181 deletions.
diff --git a/schema/definitions/0.8.0/examples/aggregated_surface_depth.yml b/schema/definitions/0.8.0/examples/aggregated_surface_depth.yml
@@ -1,6 +1,13 @@
+# Example metadata for an aggregated surface.
+
+# An aggregated surface is a statistical representation of a distribution of surfaces.
+# E.g. 200 realizations produce a surface representing the same horizon. This is now a
+# distribution representing this surface with n=200. An aggregated surface is a
+# statistical representation of this distribution, e.g. "mean", "min", "max", "p10", etc.
+
 $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.
+version: "0.8.0"
+source: fmu
 
 tracklog:
   - datetime: 2020-10-28T14:28:02
@@ -12,12 +19,9 @@ tracklog:
       id: peesv
     event: updated
 
-class: surface
-
-# fmu:
-# The fmu block in data objects have more sub-elements compared to ensemble objects.
+class: surface # class is the main identifier of the data type.
 
-fmu:
+fmu: # the fmu-block contains information directly related to the FMU context
   model:
     name: ff
     revision: 21.0.0.dev
@@ -28,10 +32,24 @@ fmu:
   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
+    restart_from: 15ce3b84-766f-4c93-9050-b154861f9100   # fmu.iteration.uuid for another iteration/case
+
+  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"
 
-  aggregation: # similar to "realization" for aggregated data
-    operation: mean  # Avoiding "type"
-    realization_ids:  # Avoiding just "realization" to avoid confusion with the "realization" definition above
+  aggregation:
+    operation: mean
+    realization_ids: # a list of realization IDs used for this aggregation
       - 0
       - 1
       - 2
@@ -43,29 +61,17 @@ fmu:
       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_CREVASSE: 0.3
-      KVKH_LS: 0.7
       KVKH_US: 0.6
       FAULT_SEAL_SCALING: 0.1
       FWL_CENTRAL: 1677
 
-    id: 15ce3b84-766f-4c93-9050-b154861f9100  # Identifier for identifying common aggregation source
-
-  case:
-    name: MyCaseName
-    uuid: 8bb56d60-8758-481a-89a4-6bac8561d38e # (pseudo-)random valid uuid4
-    user:
-      id: jriv # $USER from ERT
-    description:
-      - yet other detailed description
-      - optional
-    restart_from: 15ce3b84-766f-4c93-9050-b154861f9100   # fmu.iteration.uuid for another iteration/case
-
-  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"
+    # the aggregation ID is an identifier for a specific distribution
+    # E.g. "min" and "max" for the same set of input realizations.
+    id: 15ce3b84-766f-4c93-9050-b154861f9100
 
 file:
   relative_path: iter-0/share/results/maps/volantis_gp_base--amplitude--mean.gri # case-relative
@@ -75,6 +81,8 @@ file:
 
 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
@@ -89,17 +97,12 @@ data: # The data block describes the actual data (e.g. surface). Only present in
     stratigraphic: true
     offset: 8.3
 
-  stratigraphic_alias: # other stratigraphic entities this corresponds to in the strat column, e.g. Top Viking vs Top Draupne. Ref issue.
+  stratigraphic_alias: # other stratigraphic entities this corresponds to in the strat column, e.g. Top Viking vs Top Draupne.
     - SomeName Fm. 1 Top
   alias: # other known-as names, such as name used inside RMS etc
     - somename_fm_1_top
     - top_somename
 
-  # content is flexible more than standardized for now.
-  content: depth
-
-  # 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: mean
@@ -177,14 +180,14 @@ masterdata:
         uuid: ad214d85-8a1d-19da-e053-c918a4889309
     discovery:
       - short_identifier: DROGON
-        uuid: ad214d85-8a1d-19da-e053-c918a4889309
+        uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon
     field:
       - identifier: DROGON
-        uuid: 00000000-0000-0000-0000-000000000000
-    coordinate_system:  # changing from "coordinates" to clarify this is not content
+        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: 12345678-1234-1234-1234-123456789012
+      uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon
 
diff --git a/schema/definitions/0.8.0/examples/case.yml b/schema/definitions/0.8.0/examples/case.yml
@@ -1,9 +1,8 @@
-# example YAML file for ensembles (a parent object in Sumo)
+# Example metadata for an FMU case. In the parent/child system, this is a parent object.
 
 $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.
-
+version: "0.8.0"
+source: fmu
 tracklog:
   - datetime: 2020-10-28T14:28:02
     user:
@@ -14,12 +13,9 @@ tracklog:
       id: peesv
     event: updated
 
-class: case
-
-# no "data" block in ensemble objects
+class: case # class is the main identifier of the data type.
 
-# the "fmu" block in ensembles only have "model" and "ensemble" sub-elements
-fmu:
+fmu: # the fmu-block contains information directly related to the FMU context
   model:
     name: ff
     revision: 21.0.0.dev
@@ -29,27 +25,17 @@ fmu:
 
   case:
     name: MyCaseName
-    uuid: 8bb56d60-8758-481a-89a4-6bac8561d38e # (pseudo-)random valid uuid4
+    uuid: 8bb56d60-8758-481a-89a4-6bac8561d38e
     user:
       id: jriv # $USER from ERT
     description:
       - yet other detailed description
       - optional
     restart_from: 15ce3b84-766f-4c93-9050-b154861f9100   # fmu.iteration.uuid for another iteration/case
 
-# access:
-# Level containing properties used for access control
-
 access:
   asset:
-    name: Drogon  # adding level to make room for unique ID in the future
-
-# ensemble objects have no ssdl details
-
-# masterdata:
-# These are static data read from external config YAML file (fmuconfig or similar).
-# Some of these static data are used while processing to populate some non-required
-# fields in data block (for example names alias, color-tables)
+    name: Drogon
 
 masterdata:
   smda:
@@ -58,13 +44,13 @@ masterdata:
         uuid: ad214d85-8a1d-19da-e053-c918a4889309
     discovery:
       - short_identifier: DROGON
-        uuid: ad214d85-8a1d-19da-e053-c918a4889309
+        uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon
     field:
       - identifier: DROGON
-        uuid: 00000000-0000-0000-0000-000000000000
+        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: 12345678-1234-1234-1234-123456789012
+      uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon
diff --git a/schema/definitions/0.8.0/examples/polygons_field_outline.yml b/schema/definitions/0.8.0/examples/polygons_field_outline.yml
@@ -1,6 +1,8 @@
+# Example metadata for a polygon(s)
+
 $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.
+version: "0.8.0"
+source: fmu
 
 tracklog:
   - datetime: 2020-10-28T14:28:02
@@ -12,25 +14,25 @@ tracklog:
       id: peesv
     event: updated
 
-class: polygons
+class: polygons # class is the main identifier of the data type.
 
 # fmu:
 # The fmu block in data objects have more sub-elements compared to ensemble objects.
 
-fmu:
+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: # not sure, but a reference to the workflow / job that made this. Making it expandable.
+  workflow:
     reference: rms/structural_model
 
   case:
     name: MyCaseName
-    uuid: 8bb56d60-8758-481a-89a4-6bac8561d38e # (pseudo-)random valid uuid4
+    uuid: 8bb56d60-8758-481a-89a4-6bac8561d38e
     user:
       id: jriv # $USER from ERT
     description:
@@ -40,34 +42,24 @@ fmu:
 
   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
+    uuid: 4b939310-34b1-4179-802c-49460bc0f799
     name: "iter-0" # /"pred"
 
-  realization:  # could be expanded in the future?
+  realization:
     id: 33
     uuid: 29a15b21-ce13-471b-9a4a-0f791552aa51 # hash of case.uuid + iteration.uuid + realization.id
     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_CREVASSE: 0.3
-      KVKH_LS: 0.7
       KVKH_US: 0.6
       FAULT_SEAL_SCALING: 0.1
       FWL_CENTRAL: 1677
-    jobs: # directly pass jobs.json. This is a lot of content, only a stub is included here.
-      umask: '0002'
-      DATA_ROOT: /some/path/20.4.0_20201106/ert/model
-      anything: something
-      something:
-        anything: something
-      global_update_path: {}
-      jobList:
-      - name: MAKE_DIRECTORY
-        min_arg: 1
-        anything: something
 
 file:
   relative_path: realization-33/iter-0/share/results/polygons/field_outline--goc.gri # case-relative
@@ -77,14 +69,13 @@ file:
 
 data: # The data block describes the actual data (e.g. surface). Only present in data objects
 
+  content: field_outline  # white-listed and standardized
+
   # if stratigraphic, name must match the strat column. This is the official name of this surface.
   name: field_outline--goc
   stratigraphic: false  # if true, this is a stratigraphic surface found in the strat column
 
-  # content is flexible more than standardized for now.
-  content: field_outline
-
-  # 
+  # content-specific tag: When content == "field_outline", expect the 'field_outline' tag
   field_outline:
     contact: goc
 
@@ -142,14 +133,14 @@ masterdata:
         uuid: ad214d85-8a1d-19da-e053-c918a4889309
     discovery:
       - short_identifier: DROGON
-        uuid: ad214d85-8a1d-19da-e053-c918a4889309
+        uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon
     field:
       - identifier: DROGON
-        uuid: 00000000-0000-0000-0000-000000000000
-    coordinate_system:  # changing from "coordinates" to clarify this is not content
+        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: 12345678-1234-1234-1234-123456789012
+      uuid: 00000000-0000-0000-0000-000000000000 # mock uuid for Drogon