fmu-sumo 1.0.4

Python package for interacting with Sumo in an FMU setting

fmu-sumo

This package is intended for interaction with Sumo within the FMU (Fast Model Update(TM)) ecosystem.

Want to contribute? Read our contributing guidelines

Explorer

:warning: OpenVDS does not publish builds for MacOS. You can still use the Explorer without OpenVDS, but some Cube methods will not work.

Explore and retrieve data from Sumo.

from fmu.sumo.explorer import Explorer

sumo = Explorer()

Example: Find cases

# List of all available cases
cases = sumo.cases

# Get filter values
cases.statuses
cases.users
cases.fields

# Apply filters
cases = cases.filter(status=["keep", "offical"], user="peesv", field="DROGON")

for case in cases:
    print(case.uuid)
    print(case.name)

# select case
case = cases[0]

Example: Retrieve case objects

Get objects within a case through case.[CONTEXT].[OBJECT_TYPE].

Realized data

# All realized surface objects in case
surfs = case.surfaces

# Get filter values
surfs.names
surfs.tagnames
surfs.iterations

# Apply filters
surfs = surfs.filter(name="surface_name", tagname="surface_tagname", iteration="iter-0")

# Get surface
surf = surfs[0]

# Metadata
surf.uuid
surf.name
surf.tagname
surf.iteration
surf.realization

# Binary
surf.blob

# Get xtgeo.RegularSurface
%matplotlib inline
reg = surf.to_regular_surface()
reg.quickplot()

Aggregated data

# All aggregated surfaces in case
surfs = case.surfaces.filter(aggregation=True)

# Get filter values
surfs.names
surfs.tagnames
surfs.iterations
surfs.aggregations

# Apply filters
surfs = surfs.filter(name="surface_name", tagname="surface_tagname", iteration="iter-0", aggregation="mean")

# Get surface
surf = surfs[0]

Observed data

# All observed surfaces in case
surfs = case.surfaces.filter(is_observation=True)

# Get filter values
surfs.names
surfs.tagnames

# Apply filters
surfs = surfs.filter(name="surface_name", tagname="surface_tagname")

# Get surfaces
surf = surfs[0]