def test_apply(tmpdir):
"""
Test the callback functionality
"""
if "__file__" in globals():
# Easen up copying test code into interactive sessions
testdir = os.path.dirname(os.path.abspath(__file__))
else:
testdir = os.path.abspath(".")
tmpdir.chdir()
symlink_iter(os.path.join(testdir, "data/testensemble-reek001"), "iter-0")
ens = ScratchEnsemble("reektest", "realization-*/iter-0")
def ex_func1():
"""Example function that will return a constant dataframe"""
return pd.DataFrame(index=["1", "2"],
columns=["foo", "bar"],
data=[[1, 2], [3, 4]])
result = ens.apply(ex_func1)
assert isinstance(result, pd.DataFrame)
assert "REAL" in result.columns
assert len(result) == 10
# Check that we can internalize as well
ens.apply(ex_func1, localpath="df-1234")
int_df = ens.get_df("df-1234")
assert "REAL" in int_df
assert len(int_df) == len(result)
if SKIP_FMU_TOOLS:
return
# Test if we can wrap the volumetrics-parser in fmu.tools:
# It cannot be applied directly, as we need to combine the
# realization's root directory with the relative path coming in:
def rms_vol2df(kwargs):
"""Example function for bridging with fmu.tools to parse volumetrics"""
fullpath = os.path.join(kwargs["realization"].runpath(),
kwargs["filename"])
# The supplied callback should not fail too easy.
if os.path.exists(fullpath):
return volumetrics.rmsvolumetrics_txt2df(fullpath)
return pd.DataFrame()
rmsvols_df = ens.apply(rms_vol2df,
filename="share/results/volumes/" +
"geogrid_vol_oil_1.txt")
assert rmsvols_df["STOIIP_OIL"].sum() > 0
assert len(rmsvols_df["REAL"].unique()) == 4
def test_smry_via_ecl2df():
"""Test that we could use ecl2df for smry extraction instead
of the native code inside fmu-ensemble"""
def get_smry(kwargs):
"""Callback function to extract smry data using ecl2df on a
ScratchRealization"""
eclfiles = kwargs["realization"].get_eclfiles()
return ecl2df.summary.df(eclfiles,
time_index=kwargs["time_index"],
column_keys=kwargs["column_keys"])
if "__file__" in globals():
testdir = os.path.dirname(os.path.abspath(__file__))
else:
testdir = os.path.abspath(".")
reekens = ScratchEnsemble(
"reektest",
testdir + "/data/testensemble-reek001/" + "realization-*/iter-0")
if not HAVE_ECL2DF:
pytest.skip()
callback_smry = reekens.apply(get_smry,
column_keys="FOPT",
time_index="yearly")
direct_smry = reekens.get_smry(column_keys="FOPT", time_index="yearly")
assert callback_smry["FOPT"].sum() == direct_smry["FOPT"].sum()
assert callback_smry["REAL"].sum() == direct_smry["REAL"].sum()
def test_reek():
"""Import the reek ensemble and apply ecl2df functions on
the realizations"""
if "__file__" in globals():
testdir = os.path.dirname(os.path.abspath(__file__))
else:
testdir = os.path.abspath(".")
reekens = ScratchEnsemble(
"reektest",
testdir + "/data/testensemble-reek001/" + "realization-*/iter-0")
if not HAVE_ECL2DF:
pytest.skip()
def extract_compdat(kwargs):
"""Callback fnction to extract compdata data using ecl2df
on a ScratchRealization"""
eclfiles = kwargs["realization"].get_eclfiles()
if not eclfiles:
print("Could not obtain EclFiles object for realization " +
str(kwargs["realization"].index))
return ecl2df.compdat.deck2dfs(eclfiles.get_ecldeck())["COMPDAT"]
allcompdats = reekens.apply(extract_compdat)
assert not allcompdats.empty
assert 0 in allcompdats["REAL"]
assert "KH" in allcompdats
def test_get_df():
"""Test the data retrieval functionality
get_df() in the ensemble context is an aggregator, that will aggregate
data from individual realaizations to the ensemble level, with
optional merging capabilities performed on realization level."""
testdir = os.path.dirname(os.path.abspath(__file__))
ens = ScratchEnsemble(
"reektest",
testdir + "/data/testensemble-reek001/" + "realization-*/iter-0")
smry = ens.load_smry(column_keys="FO*", time_index="yearly")
assert not ens.get_df("unsmry--yearly").empty
assert not ens.get_df("unsmry--yearly.csv").empty
assert not ens.get_df("share/results/tables/unsmry--yearly").empty
assert not ens.get_df("share/results/tables/unsmry--yearly.csv").empty
with pytest.raises(KeyError):
# pylint: disable=pointless-statement
ens.get_df("unsmry--monthly")
ens.load_smry(column_keys="FO*", time_index="monthly")
assert not ens.get_df("unsmry--monthly").empty
with pytest.raises(KeyError):
# pylint: disable=pointless-statement
ens.get_df("unsmry-monthly")
# Tests that we can do merges directly:
params = ens.get_df("parameters.txt")
smryparams = ens.get_df("unsmry--yearly", merge="parameters")
# The set union is to handle the REAL column present in both smry and params:
assert len(smryparams.columns) == len(
set(smry.columns).union(params.columns))
# Test multiple merges:
outputs = ens.load_txt("outputs.txt")
assert len(
ens.get_df("unsmry--yearly",
merge=["parameters", "outputs.txt"]).columns) == len(
set(smry.columns).union(params.columns).union(
outputs.columns))
# Try merging dataframes:
ens.load_csv("share/results/volumes/simulator_volume_fipnum.csv")
# Inject a mocked dataframe to the realization, there is
# no "add_data" API for ensembles, but we can use the apply()
# functionality
def fipnum2zone():
"""Helper function for injecting mocked frame into
each realization"""
return pd.DataFrame(
columns=["FIPNUM", "ZONE"],
data=[
[1, "UpperReek"],
[2, "MidReek"],
[3, "LowerReek"],
[4, "UpperReek"],
[5, "MidReek"],
[6, "LowerReek"],
],
)
ens.apply(fipnum2zone, localpath="fipnum2zone")
volframe = ens.get_df("simulator_volume_fipnum", merge="fipnum2zone")
assert "ZONE" in volframe
assert "FIPNUM" in volframe
assert "STOIIP_OIL" in volframe
assert len(volframe["ZONE"].unique()) == 3
# Merge with scalar data:
ens.load_scalar("npv.txt")
vol_npv = ens.get_df("simulator_volume_fipnum", merge="npv.txt")
# (this particular data combination does not really make sense)
assert "STOIIP_OIL" in vol_npv
assert "npv.txt" in vol_npv
