dataio.export.rms package

export_structure_depth_fault_lines(project, horizon_folder)[source]

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}")
export_structure_depth_fault_surfaces(project, structural_model_name)[source]

Simplified interface when exporting triangulated fault surfaces from RMS.

Parameters:

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

  • structural_model_name (str) – name of the structural model

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_structure_depth_fault_surfaces

export_results = export_structure_depth_fault_surfaces(
    project,
    "structural_model_name"
)

for result in export_results.items:
    print(f"Output surfaces to {result.absolute_path}")
export_structure_depth_surfaces(project, horizon_folder)[source]

Simplified interface when exporting modelled depth surfaces 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_surfaces

export_results = export_structure_depth_surfaces(project, "DS_extracted")

for result in export_results.items:
    print(f"Output surfaces to {result.absolute_path}")
export_structure_time_surfaces(project, horizon_folder)[source]

Simplified interface when exporting modelled time surfaces 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_time_surfaces

export_results = export_structure_time_surfaces(project, "TS_extracted")

for result in export_results.items:
    print(f"Output surfaces to {result.absolute_path}")
export_grid_extracted_depth_surfaces(project, horizon_folder)[source]

Simplified interface when exporting extracted grid surfaces 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_grid_extracted_depth_surfaces

export_results = export_grid_extracted_depth_surfaces(
    project, "geogrid_DS_extracted"
)

for result in export_results.items:
    print(f"Output surfaces to {result.absolute_path}")
export_grid_model_static(project, gridname, zonation, regions, porosity, permeability, saturation_water, facies=None, net_to_gross=None, volume_shale=None, permeability_vertical=None)[source]

Simplified interface when exporting a grid model with common properties from RMS.

Parameters:

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

  • gridname (str) – Name of the grid model.

  • zonation (str) – Name of the zone property.

  • regions (str) – Name of the regions property.

  • porosity (str) – Name of the porosity property.

  • permeability (str) – Name of the permeability property.

  • saturation_water (str) – Name of the water saturation property.

  • facies (str | None) – Name of the facies property.

  • net_to_gross (str | None) – Name of the net to gross property.

  • volume_shale (str | None) – Name of the volume shale property.

  • permeability_vertical (str | None) – Name of the vertical permeability property.

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_grid_model_static

export_results = export_grid_model_static(
    project,
    gridname="Geogrid",
    zonation="Zone",
    regions="Region",
    porosity="PHIT",
    permeability="KLOGH",
    saturation_water="SW",
    facies="FACIES",
    )

for result in export_results.items:
    print(f"Exported item to {result.absolute_path}")
export_structure_depth_isochores(project, zone_folder)[source]

Simplified interface when exporting modelled depth isochores from RMS.

Parameters:

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

  • zone_folder (str) – Name of zone folder in RMS.

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_structure_depth_isochores

export_results = export_structure_depth_isochores(
    project, "IS_extracted"
)

for result in export_results.items:
    print(f"Output isochore surfaces to {result.absolute_path}")
export_inplace_volumes(project, grid_name, volume_job_name)[source]

Simplified interface when exporting volume tables (and assosiated data) from RMS.

Parameters:

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

  • grid_name (str) – Name of 3D grid model in RMS.

  • volume_job_name (str) – Name of the volume job.

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_inplace_volumes

export_results = export_inplace_volumes(project, "Geogrid", "geogrid_volumes")

for result in export_results.items:
    print(f"Output volumes to {result.absolute_path}")
export_rms_volumetrics(*args, **kwargs)[source]

Deprecated function. Use export_inplace_volumes instead.

Return type:

ExportResult

export_field_outline(project)[source]

Simplified interface when exporting field outline from RMS.

Parameters:

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

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_field_outline

export_results = export_field_outline(project)

for result in export_results.items:
    print(f"Output field outline polygon to {result.absolute_path}")
export_fluid_contact_surfaces(project)[source]

Simplified interface when exporting initial fluid contact surfaces from RMS.

Parameters:

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

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_fluid_contact_surfaces

export_results = export_fluid_contact_surfaces(project)

for result in export_results.items:
    print(f"Output surfaces to {result.absolute_path}")
export_fluid_contact_outlines(project)[source]

Simplified interface when exporting initial fluid contact outlines from RMS.

Parameters:

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

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_fluid_contact_outlines

export_results = export_fluid_contact_outlines(project)

for result in export_results.items:
    print(f"Output polygon to {result.absolute_path}")
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}")

Submodules