bulum.trans.transformers module

get_exceedence(obs_df, mod_df, plotting_position='cunnane') → DataFrame

_summary_

Parameters:

• obs_df (DataFrame) – Dataframe of observed values.

• mod_df (DataFrame) – _description_

• plotting_position (str, optional) – Defaults to “cunnane”. Other supported values: “weibull”, “gringorten”. See https://glossary.ametsoc.org/wiki/Plotting_position.

Returns:

A dataframe of sorted values with index given by plotting position.

Return type:

pd.DataFrame

get_exceedence_plotting_position(n: int, plotting_position='cunnane') → list[float]

Get plotting position values for a given length.

Parameters:

• n (int)

• plotting_position (str, optional) – Defaults to “cunnane”. Other supported values: “weibull”, “gringorten”. See https://glossary.ametsoc.org/wiki/Plotting_position.

Raises:

ValueError – If plotting position is not supported.

Returns:

A list of length n of plotting positions.

Return type:

list of float

join_on_dates(df1: DataFrame, df2: DataFrame, assert_format_standards=True) → DataFrame

Join the input dataframes on datetime index.

Assumes df1 and df2 both have datetime indexes with values that are daily, and sequentially ascending.

Parameters:

• df1 (DataFrame)

• df2 (DataFrame)

• assert_format_standards (bool, default True) – Enforce dataframe standards.

Returns:

_type_: _description_

Return type:

pd.Dataframe