API

The details of classes and methods

Class to hold information about an ERT run on disk.

The CaseOnDisk object is a representation of files belonging to an FMU case, as they are stored on the Scratch disk.

A Case in this context is a set of metadata describing this particular case, and an arbitrary number of files belonging to this case. Each file is in reality a file pair, consisting of a data file (could be any file type) and a metadata file (yaml formatted, according) to FMU standards.

Example for initialization:

>>> from fmu import sumo

>>> env = 'dev'
>>> case_metadata_path = 'path/to/case_metadata.yaml'
>>> casepath = 'path/to/casepath/'

>>> sumoclient = sumo.wrapper.SumoClient(env=env)
>>> case = sumo.CaseOnDisk(
        case_metadata_path=case_metadata_path,
        casepath=casepath,
        sumoclient=sumoclient)

After initialization, files must be explicitly indexed into the CaseOnDisk object:

>>> case.add_files()

When initialized, the case can be uploaded to Sumo:

>>> case.upload()

param case_metadata_path:

Path to the case_metadata file for the case

type case_metadata_path:

str

param casepath:

Path to the case

type casepath:

str

param sumoclient:

SumoConnection object

type sumoclient:

sumo.wrapper.SumoClient