dataio.export.rms.simulator_fipregions_mapping module¶

create_fipnum_property(project, grid_name, region, zone)[source]¶

Simplified interface for creating a FIPNUM property in RMS and exporting the corresponding zone / region mappings.

The FIPNUM property will have a unique value per region / zone combination and the mapping between a FIPNUM value and the corresponding region and zone names will be exported as a standard result ‘simulator_fipregions_mapping’.

Parameters:

project (Any) – The ‘magic’ project variable in RMS.
grid_name (str) – Name of the grid in RMS.
region (str) – Name of the region property in the grid model.
zone (str) – Name of the zone property in the grid model.

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import create_fipnum_property

export_results = create_fipnum_property(
    project,
    grid_name="Simgrid",
    region="Region",
    zone="Zone"
)

for result in export_results.items:
    print(f"Fipnum mappings are exported to {result.absolute_path}")