bulum 0.3.3.dev1__py3-none-any.whl → 0.3.4.dev1__py3-none-any.whl

bulum/__init__.py

@@ -1,3 +1,3 @@
-from .version import __version__
-from .demo import *
+from .version import __version__
+from .demo import *
 #from .stoch import *

bulum/clim/__init__.py

@@ -1 +1 @@
-from .clim import *
+from .clim import *

bulum/clim/clim.py

@@ -1,148 +1,148 @@
-import numpy as np
-import pandas as pd
-
-
-def derive_transformation_curves(original_ts: pd.Series, augmented_ts: pd.Series, season_start_months=[1,2,3,4,5,6,7,8,9,10,11,12], epsilon=1e-3) -> dict:
-    """Returns a dictionary of exceedence-based transformation curves - one for
-    each season with the season's start month as the key. These are tables that
-    map from exceedance (cunnane plotting position as a fraction) to a scaling
-    factor. These are intended to be used to effectively summarise
-    climate-change adjustments, and allow them to be transported from one
-    timeseries to another.
-
-    Parameters
-    ----------
-    original_ts : pd.Series
-    augmented_ts : pd.Series
-    season_start_months : list, optional
-        Defaults to [1,2,3,4,5,6,7,8,9,10,11,12].
-    
-    """
-    df = pd.DataFrame()
-    df["x"] = original_ts
-    df["y"] = augmented_ts
-    df = df.dropna() # Force common period
-    answer = {}
-    for i in range(len(season_start_months)):
-        # Get a list of the months in this season
-        start_month = season_start_months[i]
-        season_len = (season_start_months + [m + 12 for m in season_start_months])[i + 1] - start_month
-        months_in_this_season = [1,2,3,4,5,6,7,8,9,10,11,12,1,2,3,4,5,6,7,8,9,10,11,12][start_month - 1: start_month - 1 + season_len]
-        # Find the data for this season
-        df_m = df[[int(d[5:7]) in months_in_this_season for d in df.index]] #d[5:7] is the month part of the date string
-        x = np.sort(df_m.x.values)
-        y = np.sort(df_m.y.values)
-        # The transformation factor is y/x except when the original value x is zero (<epsilon) in which case we default to 1.0
-        f = np.where(x < epsilon, 1.0, y / x)
-        n = len(x)
-        ii = [i + 1 for i in range(n)] #index starting at 1
-        p = [(i - 0.4)/(n + 0.2) for i in ii]
-        answer[start_month] = [p,f]
-    return answer     
-
-    
-def apply_transformation_curves(tranformation_curves: dict, series: pd.Series) -> pd.Series:
-    """Applies seasonal transformation curves to an input series.
-    Refer to the function `derive_transformation_curves`.
-
-    Parameters
-    ----------
-    tranformation_curves : dict
-    series : pd.Series
-
-    Returns
-    -------
-    pd.Series
-    """
-    dates = series.index
-    answer = series.copy()
-    # Apply each transformation curves to the whole series. Splice the appropriate 
-    # parts (seasons) into the 'answer' series as we go. 
-    season_start_months = sorted(tranformation_curves.keys())
-    for i in range(len(season_start_months)):
-        # Identify the transform curve for this season
-        start_month = season_start_months[i]
-        t = tranformation_curves[start_month]
-        xp = t[0] 
-        fp = t[1]
-        # Get a list of the months in this season
-        season_len = (season_start_months + [m + 12 for m in season_start_months])[i + 1] - start_month
-        months_in_this_season = [1,2,3,4,5,6,7,8,9,10,11,12,1,2,3,4,5,6,7,8,9,10,11,12][start_month - 1: start_month - 1 + season_len]
-        # Find the data for this season
-        m = len(series)
-        season_dates = pd.Series([d for d in dates if int(d[5:7]) in months_in_this_season]) #d[5:7] is the month part of the date string
-        values = answer[season_dates]
-        # And get their ranks and plotting positions
-        rank_starting_at_one = values.rank(ascending=True) # This function is nice because equal values are assigned the same (averaged) rank.
-        n = len(values)
-        p = [(r - 0.4)/(n + 0.2) for r in rank_starting_at_one] # Cunnane plotting position
-        f = np.interp(p, xp, fp) # interpolated scaling factors
-        # Calcualte new values and update the answer
-        new_values = pd.Series([values.iloc[i] * f[i] for i in range(n)], index=season_dates)
-        answer.update(new_values)
-    # Return a pd.Series so user can easily join it back into a dataframe
-    return pd.Series(answer, index=dates, name=series.name)     
-    
-    
-def derive_transformation_factors(original_ts: pd.Series, augmented_ts: pd.Series, season_start_months=[1,2,3,4,5,6,7,8,9,10,11,12], epsilon=1e-3) -> dict:
-    """Returns a dictionary of transformation factors - one for each season 
-    with the season's start month as the key. These scaling factors are intended to 
-    be used to effectively summarise climate-change adjustments, and allow them to be 
-    transported from one timeseries to another.
-
-    Parameters
-    ----------
-    original_ts : pd.Series
-    augmented_ts : pd.Series
-    season_start_months : list, optional
-        [1,2,3,4,5,6,7,8,9,10,11,12].
-    epsilon : float 
-        Threshold below which values are treated as zero, and the associated factor defaults to 1.
-
-    """
-    # Create a map of month -> season_start_month (for all months)
-    month_to_season_map = {}
-    key = max(season_start_months)
-    for m in [1,2,3,4,5,6,7,8,9,10,11,12]:
-        if m in season_start_months:
-            key = m
-        month_to_season_map[m] = key
-    # Put the data in a dataframe, and groupby season start month
-    df = pd.DataFrame()
-    df["x"] = original_ts
-    df["y"] = augmented_ts
-    df = df.dropna() # Force common period
-    df['m'] = df.index.month
-    df['s'] = df['m'].map(month_to_season_map)
-    df2 = df.groupby('s').agg('sum')
-    df2['f'] = np.where(df2.x < epsilon, 1.0, df2.y / df2.x)
-    return df2['f'].to_dict()
-
-    
-def apply_transformation_factors(transformation_factors: dict, series: pd.Series) -> pd.Series:
-    """Applies seasonal transformation factors to an input series.
-    Refer to the function `derive_transformation_curves`.
-
-    Parameters
-    ----------
-    transformation_curves : dict
-    series : pd.Series
-
-    """
-    # Create a map of month -> factor (containing all months)
-    season_start_months = sorted(transformation_factors.keys())
-    month_to_factor_map = {}
-    key = max(season_start_months)
-    for m in [1,2,3,4,5,6,7,8,9,10,11,12]:
-        if m in season_start_months:
-            key = m
-        month_to_factor_map[m] = transformation_factors[key]
-    # Apply transformation factors to the whole series. Splice the appropriate 
-    df = pd.DataFrame()
-    df['x'] = series
-    df['m'] = df.index.month
-    df['f'] = df['m'].map(month_to_factor_map)
-    df['y'] = df['x'] * df['f']
-    answer = df['y']
-    answer.name = series.name
-    return answer
+import numpy as np
+import pandas as pd
+
+
+def derive_transformation_curves(original_ts: pd.Series, augmented_ts: pd.Series, season_start_months=[1,2,3,4,5,6,7,8,9,10,11,12], epsilon=1e-3) -> dict:
+    """Returns a dictionary of exceedence-based transformation curves - one for
+    each season with the season's start month as the key. These are tables that
+    map from exceedance (cunnane plotting position as a fraction) to a scaling
+    factor. These are intended to be used to effectively summarise
+    climate-change adjustments, and allow them to be transported from one
+    timeseries to another.
+
+    Parameters
+    ----------
+    original_ts : pd.Series
+    augmented_ts : pd.Series
+    season_start_months : list, optional
+        Defaults to [1,2,3,4,5,6,7,8,9,10,11,12].
+    
+    """
+    df = pd.DataFrame()
+    df["x"] = original_ts
+    df["y"] = augmented_ts
+    df = df.dropna() # Force common period
+    answer = {}
+    for i in range(len(season_start_months)):
+        # Get a list of the months in this season
+        start_month = season_start_months[i]
+        season_len = (season_start_months + [m + 12 for m in season_start_months])[i + 1] - start_month
+        months_in_this_season = [1,2,3,4,5,6,7,8,9,10,11,12,1,2,3,4,5,6,7,8,9,10,11,12][start_month - 1: start_month - 1 + season_len]
+        # Find the data for this season
+        df_m = df[[int(d[5:7]) in months_in_this_season for d in df.index]] #d[5:7] is the month part of the date string
+        x = np.sort(df_m.x.values)
+        y = np.sort(df_m.y.values)
+        # The transformation factor is y/x except when the original value x is zero (<epsilon) in which case we default to 1.0
+        f = np.where(x < epsilon, 1.0, y / x)
+        n = len(x)
+        ii = [i + 1 for i in range(n)] #index starting at 1
+        p = [(i - 0.4)/(n + 0.2) for i in ii]
+        answer[start_month] = [p,f]
+    return answer     
+
+    
+def apply_transformation_curves(tranformation_curves: dict, series: pd.Series) -> pd.Series:
+    """Applies seasonal transformation curves to an input series.
+    Refer to the function `derive_transformation_curves`.
+
+    Parameters
+    ----------
+    tranformation_curves : dict
+    series : pd.Series
+
+    Returns
+    -------
+    pd.Series
+    """
+    dates = series.index
+    answer = series.copy()
+    # Apply each transformation curves to the whole series. Splice the appropriate 
+    # parts (seasons) into the 'answer' series as we go. 
+    season_start_months = sorted(tranformation_curves.keys())
+    for i in range(len(season_start_months)):
+        # Identify the transform curve for this season
+        start_month = season_start_months[i]
+        t = tranformation_curves[start_month]
+        xp = t[0] 
+        fp = t[1]
+        # Get a list of the months in this season
+        season_len = (season_start_months + [m + 12 for m in season_start_months])[i + 1] - start_month
+        months_in_this_season = [1,2,3,4,5,6,7,8,9,10,11,12,1,2,3,4,5,6,7,8,9,10,11,12][start_month - 1: start_month - 1 + season_len]
+        # Find the data for this season
+        m = len(series)
+        season_dates = pd.Series([d for d in dates if int(d[5:7]) in months_in_this_season]) #d[5:7] is the month part of the date string
+        values = answer[season_dates]
+        # And get their ranks and plotting positions
+        rank_starting_at_one = values.rank(ascending=True) # This function is nice because equal values are assigned the same (averaged) rank.
+        n = len(values)
+        p = [(r - 0.4)/(n + 0.2) for r in rank_starting_at_one] # Cunnane plotting position
+        f = np.interp(p, xp, fp) # interpolated scaling factors
+        # Calcualte new values and update the answer
+        new_values = pd.Series([values.iloc[i] * f[i] for i in range(n)], index=season_dates)
+        answer.update(new_values)
+    # Return a pd.Series so user can easily join it back into a dataframe
+    return pd.Series(answer, index=dates, name=series.name)     
+    
+    
+def derive_transformation_factors(original_ts: pd.Series, augmented_ts: pd.Series, season_start_months=[1,2,3,4,5,6,7,8,9,10,11,12], epsilon=1e-3) -> dict:
+    """Returns a dictionary of transformation factors - one for each season 
+    with the season's start month as the key. These scaling factors are intended to 
+    be used to effectively summarise climate-change adjustments, and allow them to be 
+    transported from one timeseries to another.
+
+    Parameters
+    ----------
+    original_ts : pd.Series
+    augmented_ts : pd.Series
+    season_start_months : list, optional
+        [1,2,3,4,5,6,7,8,9,10,11,12].
+    epsilon : float 
+        Threshold below which values are treated as zero, and the associated factor defaults to 1.
+
+    """
+    # Create a map of month -> season_start_month (for all months)
+    month_to_season_map = {}
+    key = max(season_start_months)
+    for m in [1,2,3,4,5,6,7,8,9,10,11,12]:
+        if m in season_start_months:
+            key = m
+        month_to_season_map[m] = key
+    # Put the data in a dataframe, and groupby season start month
+    df = pd.DataFrame()
+    df["x"] = original_ts
+    df["y"] = augmented_ts
+    df = df.dropna() # Force common period
+    df['m'] = df.index.month
+    df['s'] = df['m'].map(month_to_season_map)
+    df2 = df.groupby('s').agg('sum')
+    df2['f'] = np.where(df2.x < epsilon, 1.0, df2.y / df2.x)
+    return df2['f'].to_dict()
+
+    
+def apply_transformation_factors(transformation_factors: dict, series: pd.Series) -> pd.Series:
+    """Applies seasonal transformation factors to an input series.
+    Refer to the function `derive_transformation_curves`.
+
+    Parameters
+    ----------
+    transformation_curves : dict
+    series : pd.Series
+
+    """
+    # Create a map of month -> factor (containing all months)
+    season_start_months = sorted(transformation_factors.keys())
+    month_to_factor_map = {}
+    key = max(season_start_months)
+    for m in [1,2,3,4,5,6,7,8,9,10,11,12]:
+        if m in season_start_months:
+            key = m
+        month_to_factor_map[m] = transformation_factors[key]
+    # Apply transformation factors to the whole series. Splice the appropriate 
+    df = pd.DataFrame()
+    df['x'] = series
+    df['m'] = df.index.month
+    df['f'] = df['m'].map(month_to_factor_map)
+    df['y'] = df['x'] * df['f']
+    answer = df['y']
+    answer.name = series.name
+    return answer

bulum/clim/tests/test_clim.py

@@ -1,71 +1,71 @@
-import unittest
-import os
-import bulum.io as bio
-import bulum.clim as ocl
-import bulum.utils as out
-import pandas as pd
-
-
-class Tests(unittest.TestCase):
-
-    @classmethod
-    def setUpClass(cls):
-        os.makedirs("./trash", exist_ok=True)
-        return super().setUpClass()
-
-    def test_load_data_into_df(self):
-        """
-        The purpose of this is just to test that if I load 2 different files as 
-        dataframes, and then simply put them together. I.e. does it join on the
-        dates? YES IT APPEARS TO LEFT-JOIN on the dates from the first file.
-        """
-        df1 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
-        df2 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
-        df3 = pd.DataFrame()
-        df3["x"] = df1
-        df3["y"] = df2
-        # print(df3.head())
-        # print(df3.tail())
-        self.assertTrue(len(df3) == len(df1))
-        self.assertAlmostEqual(df3.x.values[-1], 136)  # these values should line up despite different starting dates for each file
-        self.assertAlmostEqual(df3.y.values[-1], 62)  # these values should line up despite different starting dates for each file
-        # And now doe the same again with files loaded in the opposite order
-        df1 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
-        df2 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
-        df3 = pd.DataFrame()
-        df3["x"] = df1
-        df3["y"] = df2
-        # print(df3.head())
-        # print(df3.tail())
-        self.assertTrue(len(df3) == len(df1))
-        self.assertAlmostEqual(df3.x.values[-1], 62)  # these values should line up despite different starting dates for each file
-        self.assertAlmostEqual(df3.y.values[-1], 136)  # these values should line up despite different starting dates for each file
-
-    def test_get_exc_transform(self):
-        """
-        This gets transformation curves based on current & future climate datasets, and then checks that the transformation
-        curves have the same total number of points regardless of whether we use default seasons (monthly) or define 3 custom 
-        seasons.
-        """
-        current_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")
-        future_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")
-        answer1 = ocl.derive_transformation_curves(current_climate["FRex_FR.qqm"], future_climate["FRex_FR.qqm"])
-        answer2 = ocl.derive_transformation_curves(current_climate["FRex_FR.qqm"], future_climate["FRex_FR.qqm"], season_start_months=[3, 7, 9])
-        total_len_1 = sum([len(a[1]) for a in answer1.values()])
-        total_len_2 = sum([len(a[1]) for a in answer2.values()])
-        self.assertEqual(total_len_1, total_len_2)
-        self.assertTrue(total_len_1 > 0)
-
-    def test_apply_transformation_curves(self):
-        current_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")
-        future_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")
-        t = ocl.derive_transformation_curves(current_climate["FRex_FR.qqm"], future_climate["FRex_FR.qqm"])
-        answer = pd.DataFrame()
-        answer["RexCurrent"] = current_climate["FRex_FR.qqm"]
-        answer["RexCurrent"] = future_climate["FRex_FR.qqm"]
-        answer["Transf"] = ocl.apply_transformation_curves(t, current_climate["FRex_FR.qqm"])
-        # print(answer["Current"].sum())
-        # print(answer["Future"].sum())
-        # print(answer["Transf"].sum())
-        self.assertAlmostEqual(answer["Transf"].sum(), 4845710.795475168)  # Actually haven't checked that this is the correct answer but looks plausible.
-        answer.to_csv("./trash/transformed.csv")
+import unittest
+import os
+import bulum.io as bio
+import bulum.clim as ocl
+import bulum.utils as out
+import pandas as pd
+
+
+class Tests(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        os.makedirs("./trash", exist_ok=True)
+        return super().setUpClass()
+
+    def test_load_data_into_df(self):
+        """
+        The purpose of this is just to test that if I load 2 different files as 
+        dataframes, and then simply put them together. I.e. does it join on the
+        dates? YES IT APPEARS TO LEFT-JOIN on the dates from the first file.
+        """
+        df1 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
+        df2 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
+        df3 = pd.DataFrame()
+        df3["x"] = df1
+        df3["y"] = df2
+        # print(df3.head())
+        # print(df3.tail())
+        self.assertTrue(len(df3) == len(df1))
+        self.assertAlmostEqual(df3.x.values[-1], 136)  # these values should line up despite different starting dates for each file
+        self.assertAlmostEqual(df3.y.values[-1], 62)  # these values should line up despite different starting dates for each file
+        # And now doe the same again with files loaded in the opposite order
+        df1 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
+        df2 = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")["FRex_FR.qqm"]
+        df3 = pd.DataFrame()
+        df3["x"] = df1
+        df3["y"] = df2
+        # print(df3.head())
+        # print(df3.tail())
+        self.assertTrue(len(df3) == len(df1))
+        self.assertAlmostEqual(df3.x.values[-1], 62)  # these values should line up despite different starting dates for each file
+        self.assertAlmostEqual(df3.y.values[-1], 136)  # these values should line up despite different starting dates for each file
+
+    def test_get_exc_transform(self):
+        """
+        This gets transformation curves based on current & future climate datasets, and then checks that the transformation
+        curves have the same total number of points regardless of whether we use default seasons (monthly) or define 3 custom 
+        seasons.
+        """
+        current_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")
+        future_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")
+        answer1 = ocl.derive_transformation_curves(current_climate["FRex_FR.qqm"], future_climate["FRex_FR.qqm"])
+        answer2 = ocl.derive_transformation_curves(current_climate["FRex_FR.qqm"], future_climate["FRex_FR.qqm"], season_start_months=[3, 7, 9])
+        total_len_1 = sum([len(a[1]) for a in answer1.values()])
+        total_len_2 = sum([len(a[1]) for a in answer2.values()])
+        self.assertEqual(total_len_1, total_len_2)
+        self.assertTrue(total_len_1 > 0)
+
+    def test_apply_transformation_curves(self):
+        current_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.withmissing.csv", date_format=r"%Y-%m-%d")
+        future_climate = bio.read_ts_csv("./src/bulum/clim/tests/Flow.out.RCP85_P2050_GCM8.csv", date_format=r"%Y-%m-%d")
+        t = ocl.derive_transformation_curves(current_climate["FRex_FR.qqm"], future_climate["FRex_FR.qqm"])
+        answer = pd.DataFrame()
+        answer["RexCurrent"] = current_climate["FRex_FR.qqm"]
+        answer["RexCurrent"] = future_climate["FRex_FR.qqm"]
+        answer["Transf"] = ocl.apply_transformation_curves(t, current_climate["FRex_FR.qqm"])
+        # print(answer["Current"].sum())
+        # print(answer["Future"].sum())
+        # print(answer["Transf"].sum())
+        self.assertAlmostEqual(answer["Transf"].sum(), 4845710.795475168)  # Actually haven't checked that this is the correct answer but looks plausible.
+        answer.to_csv("./trash/transformed.csv")

bulum/demo.py

@@ -1,6 +1,6 @@
-def hello_world():
-    print("Hello world!")
-    
-if __name__ == "__main__":
-    print(type(hello_world))
+def hello_world():
+    print("Hello world!")
+    
+if __name__ == "__main__":
+    print(type(hello_world))
     hello_world()

bulum/io/__init__.py

@@ -1,6 +1,6 @@
-from .csv_io import *
-from .res_csv_io import *
-from .idx_io import *
-from .iqqm_out_reader import *
-from .lqn_io import *
-from .general_io import *
+from .csv_io import *
+from .res_csv_io import *
+from .idx_io import *
+from .iqqm_out_reader import *
+from .lqn_io import *
+from .general_io import *