Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/src/simple_exports/simulator_fipregions_mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ of initial volumes from the dynamic simulation against static inplace volumes.
| Field | Value |
| --- | --- |
| Version | NA |
| Output | `share/results/tables/simulator_fipregions_mapping/fipnum.parquet` |
| Output | `share/results/tables/simulator_fipregions_mapping/gridname.parquet` |
| Security classification | 🟡 Internal |
:::

Expand All @@ -51,7 +51,8 @@ be used to assign `FIPNUM` values. The mappings between them will be automatical
## Result

The table mapping from a unique `FIPNUM` value to corresponding region and zone names will
be exported to `share/results/tables/simulator_fipregions_mapping/fipnum.parquet`.
be exported to `share/results/tables/simulator_fipregions_mapping/simgrid.parquet`,
given that the `FIPNUM` property was generated on a grid model named `Simgrid`.


## Standard result schema
Expand Down
7 changes: 4 additions & 3 deletions src/fmu/dataio/export/rms/simulator_fipregions_mapping.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@


class _ExportFipZoneRegionMapping(SimpleExportRMSBase):
def __init__(self, mapping_table: pa.Table) -> None:
def __init__(self, mapping_table: pa.Table, grid_name: str) -> None:
super().__init__()

self._mapping_table = mapping_table
self._grid_name = grid_name

def _get_export_config(self) -> ExportConfig:
"""Export config for the standard result."""
Expand All @@ -37,7 +38,7 @@ def _get_export_config(self) -> ExportConfig:
ExportConfig.builder()
.content(Content.mapping)
.file_config(
name=FIPNAME,
name=self._grid_name,
subfolder=StandardResultName.simulator_fipregions_mapping.value,
)
.access(Classification.internal, rep_include=False)
Expand Down Expand Up @@ -150,4 +151,4 @@ def create_fipnum_property(

mapping_table = _create_fipnum_in_project(project, grid_name, region, zone)

return _ExportFipZoneRegionMapping(mapping_table).export()
return _ExportFipZoneRegionMapping(mapping_table, grid_name).export()
21 changes: 16 additions & 5 deletions tests/test_export_rms/test_create_fipnum_property.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def mock_export_class(
_ExportFipZoneRegionMapping,
)

yield _ExportFipZoneRegionMapping(mapping_table)
yield _ExportFipZoneRegionMapping(mapping_table, "Simgrid")


@pytest.mark.usefixtures("inside_rms_interactive")
Expand Down Expand Up @@ -224,8 +224,8 @@ def test_mapping_file_is_exported_with_metadata(
)
assert export_folder.exists()

assert (export_folder / "fipnum.parquet").exists()
assert (export_folder / ".fipnum.parquet.yml").exists()
assert (export_folder / "simgrid.parquet").exists()
assert (export_folder / ".simgrid.parquet.yml").exists()


@pytest.mark.usefixtures("inside_rms_interactive")
Expand Down Expand Up @@ -257,23 +257,34 @@ def test_public_export_function(
mock_project_variable: MagicMock,
mock_export_class: _ExportFipZoneRegionMapping,
mapping_table: pa.Table,
rmssetup_with_fmuconfig: Path,
) -> None:
"""Test that the export function works and metadata is correctly set"""

from fmu.dataio.export.rms import create_fipnum_property

gridname = "Simgrid"

with (
mock.patch(
"fmu.dataio.export.rms.simulator_fipregions_mapping._create_fipnum_in_project",
return_value=mapping_table,
),
):
out = create_fipnum_property(mock_project_variable, "Simgrid", "Region", "Zone")
out = create_fipnum_property(mock_project_variable, gridname, "Region", "Zone")

assert len(out.items) == 1

metadata = dataio.read_metadata(out.items[0].absolute_path)
absolute_path = out.items[0].absolute_path
sharepath = (
rmssetup_with_fmuconfig.parent.parent
/ "share/results/tables/simulator_fipregions_mapping"
)
assert absolute_path == sharepath / f"{gridname.lower()}.parquet"

metadata = dataio.read_metadata(absolute_path)

assert metadata["data"]["name"] == gridname
assert metadata["data"]["content"] == "mapping"
assert metadata["access"]["classification"] == "internal"
assert (
Expand Down
1 change: 1 addition & 0 deletions tests/test_export_rms/test_export_inplace_volumes.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ def test_rms_volumetrics_export_class(exportvolumetrics: _ExportVolumetricsRMS)

metadata = dataio.read_metadata(out.items[0].absolute_path)

assert metadata["data"]["name"] == "Geogrid"
assert "volumes" in metadata["data"]["content"]
assert metadata["access"]["classification"] == "restricted"

Expand Down
Loading