ifm_contrib API Documentation¶

ifm.c.content¶

contrib_lib.content¶: alias of contrib_lib.content

class contrib_lib.content.ContentPd(doc)¶

Functions regarding accessing information from the Content Panel as pandas.DataFrames.

content(model_domain=True, selection=None, content_types=True)¶

Get the model domains content (all content items).

Returns: DataFrame with all contents
Return type: pandas.DataFrame

info()¶

Return infomation on available content items.

Returns: information on content items
Return type: pandas.DataFrame

ifm.c.dfe¶

contrib_lib.dfe¶: alias of contrib_lib.dfe

class contrib_lib.dfe.DfePd(doc)¶: Functions regarding Discrete Feature Elements using Pandas.

ifm.c.diag¶

contrib_lib.diag¶: alias of contrib_lib.diag

ifm.c.hist¶

contrib_lib.hist¶: alias of contrib_lib.hist

class contrib_lib.hist.HistPd(doc)¶

Functions to obtain data of FEFLOWs chart panels as pandas.DataFrames

history(hist_type=None, hist_subtype=0, force_time_axis=False, reference_time=None, sync_to_index=None)¶

Returns the values of any history charting window as a dataframe. Calling the function without arguments returns a dictionary of all available histories

Parameters

hist_type (str, int, ifm.Enum or None.) – History Type.
hist_subtype (int) – History Sub-Type (int)
force_time_axis (bool) – If True, the index of the dataframe will be the simulation time in days. If False (default), the index type will be of type datetime if a reference time is set in the model, and simulation time in days otherwise.
reference_time (datetime.datetime) – Specify (or override) a reference time. Note that this only accounts for this export and is not a permanent change of the model settings.

ifm.c.mesh¶

contrib_lib.mesh¶: alias of contrib_lib.mesh

class contrib_lib.mesh.MeshPd(doc)¶

Functions to obtain data of FEFLOWs Data Panel as geopandas.GeoDataFrames

dfe()¶

Reutrn a DataFrame with information on Discrete Feature Elements in the model.

Returns: DataFrame with information on DFE
Return type: pandas.DataFrame

edges()¶: Return a DataFrame with Edges and corresponding properties. :return:

elements(par=None, expr=None, distr=None, layer=None, selection=None, centroids=False, content=None)¶

Create a Pandas Dataframe with information on the model elements.

Parameters

par (dict, list or ifm.Enum) – Create additional columns with parameter values. Parameter are provided as ifm.Enum. Multiple columns are created if a list is provided. Columns can be givens custom names if a dict {column name : parid} is provided.
distr (str or list) – Name or list of names of user distributions. For each uer distribution provided, a column with distribution values will be added to the DataFrame.
expr (str or list) – Name or list of names of user expressions. For each uer expression provided, a column with with distribution values will be added to the DataFrame.
layer (int) – if provided in a 3D model, return only elements of this layer
selection (str) – if provided in a 3D model, return only elements of this selection
centroids (bool) – if True, add coordinates of centroids to DataFrame.
content (None, bool, int, list[int]) – Add elemental content to datafrane. see doc.c.conent.df.info for available items. If True, all content items are returned. if int or list(int), specific items are returned.

Returns

DataFrame, index of element index, all requested information as columns.

Return type

pandas.DataFrame

faces()¶: Return a DataFrame with Faces properties. :return:

get_available_items(Type=None)¶

Return a list of available Parameters that can be obtained by calling doc.c.mesh.df.nodes or doc.c.mesh.df.elements, respectively.

Parameters: Type (str) – Filter by Type (“elemental” or “nodal”)
Returns: DataFrame with available items
Return type: pandas.DataFrame

mlw(global_cos=True)¶

Return a pandas.DataFrame with information on all Multi-Layer wells in the model.

Returns: Dataframe with information on Mullti-Layer-wells
Return type: pandas.DataFrame

nodes(par=None, expr=None, distr=None, global_cos=True, slice=None, selection=None, budget=None, velocity=None)¶

Create a Pandas Dataframe with information on the model nodes.

Parameters

par (dict, list or ifm.Enum) – Create additional columns with parameter values. Parameter are provided as ifm.Enum. Multiple columns are created if a list is provided. Columns can be givens custom names if a dict {column name : parid} is provided.
distr (str or list) – Name or list of names of user distributions. For each uer distribution provided, a column with distribution values will be added to the DataFrame.
expr (str or list) – Name or list of names of user expressions. For each uer expression provided, a column with with distribution values will be added to the DataFrame.
global_cos (bool) – if True (default), use global instead of local coordinate system
slice (int) – if provided in a 3D model, return only nodes of this slice
selection (str) – if provided, return only nodes of this selection
budget (bool, str or [str], None.) – add nodal budget values to dataframe. Can be “flow”, “mass”, “heat”, or a list like [“flow”, “mass]. If True, all available budgets will be created. If None, no budget is calculated (default).

Returns

DataFrame, index of element nodes, all requested information as columns.

Return type

pandas.DataFrame

class contrib_lib.mesh.MeshGpd(doc)¶

Functions to obtain data of FEFLOWs Data Panel as geopandas.GeoDataFrames.

dfe()¶: Return a geoPandas.GeoDataFrame with information on all DFE in the model. :return:

elements(par=None, expr=None, distr=None, global_cos=True, layer=None, selection=None, as_2d=False, content=None, polygons_as_2d=False)¶

Create a GeoPandas GeoDataframe with information on the model elements.

Parameters

par (dict, list or ifm.Enum) – Create additional columns with parameter values. Parameter are provided as ifm.Enum. Multiple columns are created if a list is provided. Columns can be givens custom names if a dict {column name : parid} is provided.
distr (str or list) – Name or list of names of user distributions. For each uer distribution provided, a column with distribution values will be added to the DataFrame.
expr (str or list) – Name or list of names of user expressions. For each uer expression provided, a column with with distribution values will be added to the DataFrame.
global_cos (bool) – If True (default), use global instead of local coordinate system.
layer (int) – if provided in a 3D model, return only elements of this layer
selection (str) – if provided in a 3D model, return only elements of this selection

Returns

geopandas.GeoDataFrame

mlw(global_cos=True)¶: Return a geoPandas.GeoDataFrame with information on all Multi-Layer wells in the model. :return:

model_area(selection=None)¶

Get the model area as a single 2D polygon.

Parameters: selection (str) – if provided, return model area related to this elemental selection.
Returns: geopandas.GeoDataFrame.

model_borders()¶

Return a GeoDataFrame with all model borders.

Returns
Return type: shapely.geometry.LinearRing

nodes(*args, **kwargs)¶

Create a Pandas Dataframe with information on the model nodes.

Parameters

par (dict, list or ifm.Enum) – Create additional columns with parameter values. Parameter are provided as ifm.Enum. Multiple columns are created if a list is provided. Columns can be givens custom names if a dict {column name : parid} is provided.
distr (str or list) – Name or list of names of user distributions. For each uer distribution provided, a column with distribution values will be added to the DataFrame.
expr (str or list) – Name or list of names of user expressions. For each uer expression provided, a column with with distribution values will be added to the DataFrame.
global_cos (bool) – if True (default), use global instead of local coordinate system
slice (int) – if provided in a 3D model, return only nodes of this slice
selection (str) – if provided, return only nodes of this selection

Returns

geopandas.GeoDataFrame

ifm.c.obs¶

contrib_lib.obs¶: alias of contrib_lib.obs

class contrib_lib.obs.ObsGpd(doc)¶

Functions to obtain data of Observation Points as geoPandas.GeoDataFrames.

obspoints(global_cos=True, filter_by=None)¶

Get the observation points as a GeoPandas GeoDataFrame.

Parameters

global_cos (Bool) – If True, use global coordinate system (default)
filter_by (dict {str : list}) – dictionary {str : list} defining a filter. Return only observation points whose attributes defined by the key of the dictionary is member of a list provided as the value.

Returns

GeoDataFrame

Return type

geopandas.GeoDataFrame

ifm.c.plot¶

contrib_lib.plot¶: alias of contrib_lib.plot

class contrib_lib.plot.PlotGpd(doc)¶

Functions for exporting plotted data like isocontours as GeoDataFrame. Results are similar to the output of the View Components Panel of the FEFLOW GUI.

fringes(attribute_name=None, suppress_output=True, *args, **kwargs)¶

Create fringes polygons of a given nodal parameter, expression or distribution. Return the plot as a polygonal GeoDataFrame.

Returns: geopandas.GeoDataFrame

isolines(attribute_name=None, suppress_output=True, *args, **kwargs)¶

Create isolines of a given nodal parameter, expression or distribution. Return the plot as a LineString geometry-type GeoDataFrame.

Parameters

par (ifm.Enum) – Type of parameter to evaluate. Parameter are provided as ifm.Enum.
distr (str) – Name of user distribution to evaluate.
expr (str) – Name of user expression to evaluate.
slice – if provided in a 3D model, create isolines on this slice.
global_cos (bool) – If True, use global coordinate system (default: local)

Returns

geopandas.GeoDataFrame

ifm.c.sel¶

contrib_lib.sel¶: alias of contrib_lib.sel

class contrib_lib.sel.SelPd(doc)¶

Functions for getting informations on Selections in Pandas

selections(seltype=None, selections=None, budget=False, area=False)¶

Returns a DataFrame with information on selections of the selected type.

Parameters: seltype – One of ifm.Enum.SEL_*
Returns: DataFrame with information on selections
Return type: pandas.DataFrame

ifm.c.settings¶

contrib_lib.settings¶: alias of contrib_lib.settings

class contrib_lib.settings.SettingsPd(doc)¶

Functions for reading and writing global settings as pandas.DataFrames

species()¶: Return a table with information on available species :return: DataFrame with Species Information

ifm.c.sim¶

contrib_lib.simulator¶: alias of contrib_lib.simulator

class contrib_lib.simulator.SimPd(doc)¶

Functions regarding the simulator and data specific to results files, using Pandas

time_steps()¶: Get a DataFrame with information on timesteps saved in the dacfile. :return: DataFrame

ifm.c.ts¶

contrib_lib.ts¶: alias of contrib_lib.ts

class contrib_lib.ts.TsPd(doc)¶

Functions regarding time series (aka power functions)

create_from_series(tsid, series, comment=None, cyclic=False, interpolation=2, warn_on_overwrite=True, error_on_overwrite=False)¶

Create a FEFLOW time series from a pandas.Series.

Parameters

tsid – time series id
series – pd.Series. index will be
comment – comment to be set
cyclic – True of cyclic (default: False)
interpolation – Interpolation kind (default: ifm.Enum.INTERPOL_LINEAR)
warn_on_overwrite – warn if ts id is occupied (default: True)
error_on_overwrite – raise error if ts id is occupied (default: False)

Returns

info()¶: Returns a pandas.DataFrame with information on existing time series (formerly power functions).

points(tsid=None, force_time_axis=False, reference_time=None)¶

Returns the values of a given time series (formerly power function) as a dataframe. Time Series can be identified by id or comment (will raise Warning if comment is not unique). Returns a DataFrame with multiple timeseries if tsid is provided as a list (will have nan-values if indices do not match).

Parameters

tsid (int, or str, or [int or str]) – time series ID or list of time series IDs, or None (default, return all)
force_time_axis (bool) – If True, the index of the dataframe will be the simulation time in days. If False (default), the index type will be of type datetime if a reference time is set in the model, and simulation time in days otherwise.
reference_time (datetime.datetime) – Specify (or override) a reference time. Note that this only accounts for this export and is not a permanent change of the model settings.

Returns

time series as a pandas.DataFrame

Return type

pandas.DataFrame

ifm.c.user¶

contrib_lib.user¶: alias of contrib_lib.user

class contrib_lib.user.UserPd(doc)¶

Functions regarding User Data (Distributions and Expressions)

distributions()¶: Returns a pandas.DataFrame with information on existing user distributions.