Realization

pydantic model Realization[source]

The fmu.realization block contains information about the realization this data object belongs to.

Fields:
field id: int [Required]

The internal ID of the realization, represented by an integer.

Constraints:

  • ge = 0

field name: str [Required]

The name of the realization. This is typically reflecting the folder name on scratch. We recommend to use fmu.realization.id for all usage except purely visual appearance.

field uuid: UUID [Required]

The universally unique identifier for this realization. It is a hash of fmu.case.uuid and fmu.iteration.uuid and fmu.realization.id.

field is_reference: Optional[bool] = None

Flag used to determine if this realization is tagged as a reference.

Typically, a reference realization is one that includes prediction surfaces and maintains all other input parameters at their default settings. However, caution must be exercised when putting logic upon this field, as this is simply a selected realization by the user and no guarantees of what the realization represents can be made.

Note

Please note that users shall not set this flag in the metadata upon export; it is intended to be configured through interactions with the Sumo GUI.