fmu.tools.ensembles package

Submodules

fmu.tools.ensembles.ensemble_well_props module

Compute well properties/stats along a (planned) well path based on ensemble data.

The implementation is through a console script, which reads a YAML config file.

Output will be RMS well file and/or CSV files, in addition to screen info.

class fmu.tools.ensembles.ensemble_well_props.ScreenInfo(quiet=False, moreverbose=False)

Bases: object

quiet: bool = False

moreverbose: bool = False

oprint(*args)

Ordinary print info for users.

cprint(*args)

Ordinary but clean print withou leading >>, useful for e.g. dataframes.

xprint(*args)

Extra print if more verbose output is asked for.

fmu.tools.ensembles.ensemble_well_props.get_parser_args(args)

Set up parser for command line end point.

fmu.tools.ensembles.ensemble_well_props.dump_example_config()

Dump an example config file as example.yml.

fmu.tools.ensembles.ensemble_well_props.parse_config(configfile)

Parse YAML file.

class fmu.tools.ensembles.ensemble_well_props.PropsData(name, filestub, discrete=False, codes=None, interval=None)

Bases: object

Holding property data and criteria

name: str

filestub: str

discrete: bool = False

codes: Optional[list] = None

interval: Optional[list] = None

class fmu.tools.ensembles.ensemble_well_props.ConfigData(config, root=None, reals=None, itera=None, wellfile=None, welldelta=2, gridfile=None, gridreuse=False, proplist=None, report_avg_file=None, report_cum_file=None, report_keep_intermediate=False, report_show_in_terminal=True)

Bases: object

Other class data than config are evaluated from config in post_init.

config: dict

root: Optional[Path] = None

reals: Optional[list] = None

itera: Optional[str] = None

wellfile: Optional[Path] = None

welldelta: int = 2

gridfile: Optional[Path] = None

gridreuse: bool = False

proplist: Optional[List[PropsData]] = None

report_avg_file: Optional[str] = None

report_cum_file: Optional[str] = None

report_keep_intermediate: bool = False

report_show_in_terminal: bool = True

class fmu.tools.ensembles.ensemble_well_props.WellCase(well, mdlog, mdranges, delta=2)

Bases: object

well: Well

mdlog: str

mdranges: list

delta: int = 2

class fmu.tools.ensembles.ensemble_well_props.EnsembleWellProps(well, realizations, cfg, sinfo, added_logs=None, added_flag_logs=None, cumlenreport=None, cumlenreport_summary=None)

Bases: object

The ensemble well props is use for post loop analysis.

well: Well

realizations: list

cfg: ConfigData

sinfo: ScreenInfo

added_logs: Optional[dict] = None

added_flag_logs: Optional[list] = None

cumlenreport: Optional[DataFrame] = None

cumlenreport_summary: Optional[DataFrame] = None

process_ensemble_avglogs()

Make ensemble mean or mode (most-of) logs.

process_ensemble_cumlen()

Provide cumulative length statistics.

optionally_delete_logs()

optionally_delete_flag_logs()

fmu.tools.ensembles.ensemble_well_props.loop_for_compute(config, sinfo, _dryrun=False)

Collect for computing the ensemble statistics.

Parameters:

• config – The input configuration dictonary

• sinfo – Messages to screen instance

• _dryrun – For testing, skipping computation

fmu.tools.ensembles.ensemble_well_props.run_compute(real, well, prop, theprop)

Compute well props sampled from gridproperties for one propert and realization.

The well.dataframe is updated in-place with new column(s)

fmu.tools.ensembles.ensemble_well_props.process_ensemble(ens)

Process the ensemble (seen in well) according to client ‘report’ requirements.

Parameters:

ens – Instance of EnsembleWellProps which holds all relevant data

fmu.tools.ensembles.ensemble_well_props.main(args=None)

Main routine for ensemble_well_props.

Parameters:

args – Input config; if missing the command line is parsed for YAML file.

Module contents

For analysis/checks across ensembles.