AeroViz 0.1.2__py3-none-any.whl → 0.1.3b0__py3-none-any.whl

AeroViz/plot/utils/fRH.json

@@ -0,0 +1,390 @@
+{
+  "fRH": {
+    "1": 1.0,
+    "2": 1.0,
+    "3": 1.0,
+    "4": 1.0,
+    "5": 1.0,
+    "6": 1.0,
+    "7": 1.0,
+    "8": 1.0,
+    "9": 1.0,
+    "10": 1.0,
+    "11": 1.0,
+    "12": 1.0,
+    "13": 1.0,
+    "14": 1.0,
+    "15": 1.0,
+    "16": 1.0,
+    "17": 1.0,
+    "18": 1.0,
+    "19": 1.0,
+    "20": 1.0,
+    "21": 1.0,
+    "22": 1.0,
+    "23": 1.0,
+    "24": 1.0,
+    "25": 1.0,
+    "26": 1.0,
+    "27": 1.0,
+    "28": 1.0,
+    "29": 1.0,
+    "30": 1.0,
+    "31": 1.0,
+    "32": 1.0,
+    "33": 1.0,
+    "34": 1.0,
+    "35": 1.0,
+    "36": 1.0,
+    "37": 1.02,
+    "38": 1.04,
+    "39": 1.06,
+    "40": 1.08,
+    "41": 1.1,
+    "42": 1.13,
+    "43": 1.15,
+    "44": 1.18,
+    "45": 1.2,
+    "46": 1.23,
+    "47": 1.26,
+    "48": 1.28,
+    "49": 1.31,
+    "50": 1.34,
+    "51": 1.37,
+    "52": 1.41,
+    "53": 1.44,
+    "54": 1.47,
+    "55": 1.51,
+    "56": 1.54,
+    "57": 1.58,
+    "58": 1.62,
+    "59": 1.66,
+    "60": 1.7,
+    "61": 1.74,
+    "62": 1.79,
+    "63": 1.83,
+    "64": 1.88,
+    "65": 1.93,
+    "66": 1.98,
+    "67": 2.03,
+    "68": 2.08,
+    "69": 2.14,
+    "70": 2.19,
+    "71": 2.25,
+    "72": 2.31,
+    "73": 2.37,
+    "74": 2.43,
+    "75": 2.5,
+    "76": 2.56,
+    "77": 2.63,
+    "78": 2.7,
+    "79": 2.78,
+    "80": 2.86,
+    "81": 2.94,
+    "82": 3.03,
+    "83": 3.12,
+    "84": 3.22,
+    "85": 3.33,
+    "86": 3.45,
+    "87": 3.58,
+    "88": 3.74,
+    "89": 3.93,
+    "90": 4.16,
+    "91": 4.45,
+    "92": 4.84,
+    "93": 5.37,
+    "94": 6.16,
+    "95": 7.4
+  },
+  "fRHSS": {
+    "1": 1.0,
+    "2": 1.0,
+    "3": 1.0,
+    "4": 1.0,
+    "5": 1.0,
+    "6": 1.0,
+    "7": 1.0,
+    "8": 1.0,
+    "9": 1.0,
+    "10": 1.0,
+    "11": 1.0,
+    "12": 1.0,
+    "13": 1.0,
+    "14": 1.0,
+    "15": 1.0,
+    "16": 1.0,
+    "17": 1.0,
+    "18": 1.0,
+    "19": 1.0,
+    "20": 1.0,
+    "21": 1.0,
+    "22": 1.0,
+    "23": 1.0,
+    "24": 1.0,
+    "25": 1.0,
+    "26": 1.0,
+    "27": 1.0,
+    "28": 1.0,
+    "29": 1.0,
+    "30": 1.0,
+    "31": 1.0,
+    "32": 1.0,
+    "33": 1.0,
+    "34": 1.0,
+    "35": 1.0,
+    "36": 1.0,
+    "37": 1.0,
+    "38": 1.0,
+    "39": 1.0,
+    "40": 1.0,
+    "41": 1.0,
+    "42": 1.0,
+    "43": 1.0,
+    "44": 1.0,
+    "45": 1.0,
+    "46": 1.0,
+    "47": 2.3584,
+    "48": 2.3799,
+    "49": 2.4204,
+    "50": 2.4488,
+    "51": 2.4848,
+    "52": 2.5006,
+    "53": 2.5052,
+    "54": 2.5279,
+    "55": 2.5614,
+    "56": 2.5848,
+    "57": 2.5888,
+    "58": 2.616,
+    "59": 2.6581,
+    "60": 2.6866,
+    "61": 2.7341,
+    "62": 2.7834,
+    "63": 2.8272,
+    "64": 2.8287,
+    "65": 2.8594,
+    "66": 2.8943,
+    "67": 2.9105,
+    "68": 2.9451,
+    "69": 3.0105,
+    "70": 3.0485,
+    "71": 3.1269,
+    "72": 3.1729,
+    "73": 3.2055,
+    "74": 3.2459,
+    "75": 3.2673,
+    "76": 3.3478,
+    "77": 3.4174,
+    "78": 3.5202,
+    "79": 3.5744,
+    "80": 3.6329,
+    "81": 3.6905,
+    "82": 3.808,
+    "83": 3.9505,
+    "84": 4.0398,
+    "85": 4.1127,
+    "86": 4.2824,
+    "87": 4.494,
+    "88": 4.6078,
+    "89": 4.8573,
+    "90": 5.1165,
+    "91": 5.3844,
+    "92": 5.7457,
+    "93": 6.1704,
+    "94": 6.7178,
+    "95": 7.3492
+  },
+  "fRHs": {
+    "1": 1.0,
+    "2": 1.0,
+    "3": 1.0,
+    "4": 1.0,
+    "5": 1.0,
+    "6": 1.0,
+    "7": 1.0,
+    "8": 1.0,
+    "9": 1.0,
+    "10": 1.0,
+    "11": 1.0,
+    "12": 1.0,
+    "13": 1.0,
+    "14": 1.0,
+    "15": 1.0,
+    "16": 1.0,
+    "17": 1.0,
+    "18": 1.0,
+    "19": 1.0,
+    "20": 1.0,
+    "21": 1.0,
+    "22": 1.0,
+    "23": 1.0,
+    "24": 1.0,
+    "25": 1.0,
+    "26": 1.0,
+    "27": 1.0,
+    "28": 1.0,
+    "29": 1.0,
+    "30": 1.0,
+    "31": 1.0,
+    "32": 1.0,
+    "33": 1.0,
+    "34": 1.0,
+    "35": 1.0,
+    "36": 1.0,
+    "37": 1.38,
+    "38": 1.4,
+    "39": 1.42,
+    "40": 1.44,
+    "41": 1.46,
+    "42": 1.48,
+    "43": 1.49,
+    "44": 1.51,
+    "45": 1.53,
+    "46": 1.55,
+    "47": 1.57,
+    "48": 1.59,
+    "49": 1.62,
+    "50": 1.64,
+    "51": 1.66,
+    "52": 1.68,
+    "53": 1.71,
+    "54": 1.73,
+    "55": 1.76,
+    "56": 1.78,
+    "57": 1.81,
+    "58": 1.83,
+    "59": 1.86,
+    "60": 1.89,
+    "61": 1.92,
+    "62": 1.95,
+    "63": 1.99,
+    "64": 2.02,
+    "65": 2.06,
+    "66": 2.09,
+    "67": 2.13,
+    "68": 2.17,
+    "69": 2.22,
+    "70": 2.26,
+    "71": 2.31,
+    "72": 2.36,
+    "73": 2.41,
+    "74": 2.47,
+    "75": 2.54,
+    "76": 2.6,
+    "77": 2.67,
+    "78": 2.75,
+    "79": 2.84,
+    "80": 2.93,
+    "81": 3.03,
+    "82": 3.15,
+    "83": 3.27,
+    "84": 3.42,
+    "85": 3.58,
+    "86": 3.76,
+    "87": 3.98,
+    "88": 4.23,
+    "89": 4.53,
+    "90": 4.9,
+    "91": 5.35,
+    "92": 5.93,
+    "93": 6.71,
+    "94": 7.78,
+    "95": 9.34
+  },
+  "fRHl": {
+    "1": 1.0,
+    "2": 1.0,
+    "3": 1.0,
+    "4": 1.0,
+    "5": 1.0,
+    "6": 1.0,
+    "7": 1.0,
+    "8": 1.0,
+    "9": 1.0,
+    "10": 1.0,
+    "11": 1.0,
+    "12": 1.0,
+    "13": 1.0,
+    "14": 1.0,
+    "15": 1.0,
+    "16": 1.0,
+    "17": 1.0,
+    "18": 1.0,
+    "19": 1.0,
+    "20": 1.0,
+    "21": 1.0,
+    "22": 1.0,
+    "23": 1.0,
+    "24": 1.0,
+    "25": 1.0,
+    "26": 1.0,
+    "27": 1.0,
+    "28": 1.0,
+    "29": 1.0,
+    "30": 1.0,
+    "31": 1.0,
+    "32": 1.0,
+    "33": 1.0,
+    "34": 1.0,
+    "35": 1.0,
+    "36": 1.0,
+    "37": 1.31,
+    "38": 1.32,
+    "39": 1.34,
+    "40": 1.35,
+    "41": 1.36,
+    "42": 1.38,
+    "43": 1.39,
+    "44": 1.41,
+    "45": 1.42,
+    "46": 1.44,
+    "47": 1.45,
+    "48": 1.47,
+    "49": 1.49,
+    "50": 1.5,
+    "51": 1.52,
+    "52": 1.54,
+    "53": 1.55,
+    "54": 1.57,
+    "55": 1.59,
+    "56": 1.61,
+    "57": 1.63,
+    "58": 1.65,
+    "59": 1.67,
+    "60": 1.69,
+    "61": 1.71,
+    "62": 1.73,
+    "63": 1.75,
+    "64": 1.78,
+    "65": 1.8,
+    "66": 1.83,
+    "67": 1.86,
+    "68": 1.89,
+    "69": 1.92,
+    "70": 1.95,
+    "71": 1.98,
+    "72": 2.01,
+    "73": 2.05,
+    "74": 2.09,
+    "75": 2.13,
+    "76": 2.18,
+    "77": 2.22,
+    "78": 2.27,
+    "79": 2.33,
+    "80": 2.39,
+    "81": 2.45,
+    "82": 2.52,
+    "83": 2.6,
+    "84": 2.69,
+    "85": 2.79,
+    "86": 2.9,
+    "87": 3.02,
+    "88": 3.16,
+    "89": 3.33,
+    "90": 3.53,
+    "91": 3.77,
+    "92": 4.06,
+    "93": 4.43,
+    "94": 4.92,
+    "95": 5.57
+  }
+}

AeroViz/plot/utils/plt_utils.py

@@ -0,0 +1,92 @@
+from functools import wraps
+from typing import Literal
+
+import matplotlib.pyplot as plt
+from matplotlib.pyplot import Axes
+
+__all__ = ['set_figure', 'combine_legends', 'auto_label_pct']
+
+
+def set_figure(func=None,
+               *,
+               figsize: tuple | None = None,
+               fs: int | None = None,
+               fw: str = None,
+               autolayout: bool = True):
+    # For more details please see https://matplotlib.org/stable/users/explain/customizing.html
+    def decorator(_func):
+        @wraps(_func)
+        def wrapper(*args, **kwargs):
+            print(f'\tPlot:\033[96m {_func.__name__}\033[0m')
+
+            plt.rcParams['mathtext.fontset'] = 'custom'
+            plt.rcParams['mathtext.rm'] = 'Times New Roman'
+            plt.rcParams['mathtext.it'] = 'Times New Roman: italic'
+            plt.rcParams['mathtext.bf'] = 'Times New Roman: bold'
+            plt.rcParams['mathtext.default'] = 'regular'
+
+            # The font properties used by `text.Text`.
+            # The text, annotate, label, title, ticks, are used to create text
+            plt.rcParams['font.family'] = 'Times New Roman'
+            plt.rcParams['font.weight'] = fw or 'normal'
+            plt.rcParams['font.size'] = fs or 8
+
+            plt.rcParams['axes.titlesize'] = 'large'
+            plt.rcParams['axes.titleweight'] = 'bold'
+            plt.rcParams['axes.labelweight'] = 'bold'
+
+            # color
+            plt.rcParams['axes.prop_cycle'] = plt.cycler(color=['b', 'g', 'r', 'c', 'm', 'y', 'k'])
+
+            plt.rcParams['xtick.labelsize'] = 'medium'
+            plt.rcParams['ytick.labelsize'] = 'medium'
+
+            # matplotlib.font_manager.FontProperties ---> matplotlib.rcParams
+            plt.rcParams['legend.loc'] = 'best'
+            plt.rcParams['legend.frameon'] = False
+            plt.rcParams['legend.fontsize'] = 'small'
+            plt.rcParams['legend.title_fontsize'] = 'medium'
+            plt.rcParams['legend.handlelength'] = 1.5
+            plt.rcParams['legend.labelspacing'] = 0.7
+
+            plt.rcParams['figure.figsize'] = figsize or (4, 4)
+            plt.rcParams['figure.dpi'] = 200
+            plt.rcParams['figure.autolayout'] = autolayout
+
+            if ~autolayout:
+                plt.rcParams['figure.subplot.left'] = 0.1
+                plt.rcParams['figure.subplot.right'] = 0.875
+                plt.rcParams['figure.subplot.top'] = 0.875
+                plt.rcParams['figure.subplot.bottom'] = 0.125
+
+            # plt.rcParams['figure.constrained_layout.use'] = True
+
+            plt.rcParams['savefig.transparent'] = True
+
+            return _func(*args, **kwargs)
+
+        return wrapper
+
+    if func is None:
+        return decorator
+
+    return decorator(func)
+
+
+def combine_legends(axes_list: list[Axes]) -> tuple[list, list]:
+    return (
+        [legend for axes in axes_list for legend in axes.get_legend_handles_labels()[0]],
+        [label for axes in axes_list for label in axes.get_legend_handles_labels()[1]]
+    )
+
+
+def auto_label_pct(pct,
+                   symbol: bool = True,
+                   include_pct: bool = False,
+                   ignore: Literal["inner", "outer"] = 'inner',
+                   value: float = 2):
+    if not symbol:
+        return ''
+    cond = pct <= value if ignore == 'inner' else pct > value
+    label = '' if cond else '{:.1f}'.format(pct)
+    return '' if label == '' else label + '%' if include_pct else label

AeroViz/plot/utils/sklearn_utils.py

@@ -0,0 +1,49 @@
+import numpy as np
+from sklearn.linear_model import LinearRegression
+from tabulate import tabulate
+
+__all__ = ['linear_regression_base']
+
+
+def linear_regression_base(x_array: np.ndarray,
+                           y_array: np.ndarray,
+                           columns: str | list[str] | None = None,
+                           positive: bool = True,
+                           fit_intercept: bool = True):
+    if len(x_array.shape) > 1 and x_array.shape[1] >= 2:
+        model = LinearRegression(positive=positive, fit_intercept=fit_intercept).fit(x_array, y_array)
+
+        coefficients = model.coef_[0].round(3)
+        intercept = model.intercept_[0].round(3) if fit_intercept else 'None'
+        r_square = model.score(x_array, y_array).__round__(3)
+        y_predict = model.predict(x_array)
+
+        equation = ' + '.join([f'{coeff:.3f} * {col}' for coeff, col in zip(coefficients, columns)])
+        equation = equation.replace(' + 0.000 * Const', '')  # Remove terms with coefficient 0
+
+        text = 'y = ' + str(equation) + '\n' + r'$\bf R^2 = $' + str(r_square)
+        tab = tabulate([[*coefficients, intercept, r_square]], headers=[*columns, 'intercept', 'R^2'], floatfmt=".3f",
+                       tablefmt="fancy_grid")
+        print('\n' + tab)
+
+        return text, y_predict, coefficients
+
+    else:
+        x_array = x_array.reshape(-1, 1)
+        y_array = y_array.reshape(-1, 1)
+
+        model = LinearRegression(positive=positive, fit_intercept=fit_intercept).fit(x_array, y_array)
+
+        slope = model.coef_[0][0].round(3)
+        intercept = model.intercept_[0].round(3) if fit_intercept else 'None'
+        r_square = model.score(x_array, y_array).__round__(3)
+        y_predict = model.predict(x_array)
+
+        text = np.poly1d([slope, intercept])
+        text = 'y = ' + str(text).replace('\n', "") + '\n' + r'$\bf R^2 = $' + str(r_square)
+
+        tab = tabulate([[slope, intercept, r_square]], headers=['slope', 'intercept', 'R^2'], floatfmt=".3f",
+                       tablefmt="fancy_grid")
+        print('\n' + tab)
+
+        return text, y_predict, slope

AeroViz/plot/utils/units.json

@@ -0,0 +1,84 @@
+{
+  "ALWC": "ALWC (\u00b5g/m^3)",
+  "AN": "AN (\u00b5g/m^3)",
+  "AS": "AS (\u00b5g/m^3)",
+  "T_EC": "EC (\u00b5g/m^3)",
+  "T_OC": "OC (\u00b5g/m^3)",
+  "PM1": "PM_{1} (\u00b5g/m^3)",
+  "PM25": "PM_{2.5} (\u00b5g/m^3)",
+  "SIA": "SIA (\u00b5g/m^3)",
+  "POC": "POC (\u00b5g/m^3)",
+  "SOC": "SOC (\u00b5g/m^3)",
+  "total_mass": "Reconstructed PM_{2.5} (\u00b5g/m^3)",
+  "PM1/PM25": "PM_{1} / PM_{2.5}",
+  "OM_mass_ratio": "OM ratio (%)",
+  "EC_mass_ratio": "EC/PM_{2.5}",
+  "AS_mass_ratio": "AS ratio (%)",
+  "AN_mass_ratio": "AN ratio (%)",
+  "ALWC_mass_ratio": "ALWC/PM_{2.5}",
+  "SIA_mass_ratio": "SIA/PM_{2.5}",
+  "Babs": "Mie Amb Absorption (1/Mm)",
+  "Babs_dry": "Mie Dry Absorption (1/Mm)",
+  "Absorption": "Absorption (1/Mm)",
+  "Bext": "Mie Amb Extinction (1/Mm)",
+  "Bext_dry": "Mie Dry Extinction (1/Mm)",
+  "Extinction": "Extinction (1/Mm)",
+  "Bsca": "Mie Amb Scattering (1/Mm)",
+  "Bsca_dry": "Mie Dry Scattering (1/Mm)",
+  "Scattering": "Scattering (1/Mm)",
+  "Diurnal": "Hour",
+  "PBLH": "PBLH (m)",
+  "VC": "VC (m²/s)",
+  "MAC": "MAC (m²/g)",
+  "MAE": "MAE (m²/g)",
+  "MEE": "MEE (m²/g)",
+  "MSE": "MSE (m²/g)",
+  "SSA": "SSA",
+  "AAE": "AAE",
+  "Localized": "Reconstructed Extinction (1/Mm)",
+  "Modified": "Reconstructed Extinction (1/Mm)",
+  "Revised": "Reconstructed Extinction (1/Mm)",
+  "Measured": "Measured Extinction (1/Mm)",
+  "SOR": "SOR",
+  "NOR": "NOR",
+  "O3": "O_{3} (ppb)",
+  "NO2": "NO_{2} (ppb)",
+  "CO": "CO (ppm)",
+  "SO2": "SO_{2} (ppb)",
+  "kappa": "kappa",
+  "RH": "RH (\\%)",
+  "gRH": "g(RH)",
+  "fRH": "f(RH)",
+  "Factor": "Factor",
+  "Bext_internal": "Bext_{internal}",
+  "Bsca_internal": "Bsca_{internal}",
+  "Babs_internal": "Babs_{internal}",
+  "Bext_external": "Bext_{external}",
+  "Bsca_external": "Bsca_{external}",
+  "Babs_external": "Babs_{external}",
+  "Bext_dry_external": "Dry Bext_{external}",
+  "Bsca_dry_external": "Dry Bsca_{external}",
+  "Babs_dry_external": "Dry Babs_{external}",
+  "Bext_Fixed_PNSD": "Mie Amb Extinction (1/Mm)",
+  "Bext_Fixed_RI": "Mie Amb Extinction (1/Mm)",
+  "ABC": "ABC (%)",
+  "CPC_1": "CPC_1 ({\\#}/cm^{3})",
+  "CPC_2": "CPC_2 ({\\#}/cm^{3})",
+  "BC6": "BC6 (ng/cm^{3}) (880 nm)",
+  "IR BCc": "IR BCc (ng/cm^{3}) (880 nm)",
+  "AT": "Temp (^{\\circ}C)",
+  "WS": "WS (m/s)",
+  "WD": "WD ({\\circ})",
+  "y_actual": "y_{actual}",
+  "y_predict": "y_{predict}",
+  "PG": "Extinction (1/Mm)",
+  "Number_dist": "dN/dlogdp (nm^{-1}/cm^3)",
+  "Surface_dist": "dS/dlogdp (nm/cm^3)",
+  "Volume_dist": "dV/dlogdp (nm^2/cm^3)",
+  "Extinction_dist": "d{\\sigma}/dlogdp (1/Mm)",
+  "Vis_LPV": "Visibility (km)",
+  "Vis_LPV_1": "Visibility (km)",
+  "MA350_0171 IR BCc": "MA350-0171 IR BCc (ng/cm^{3}) (880 nm)",
+  "MA350_0176 IR BCc": "MA350-0176 IR BCc (ng/cm^{3}) (880 nm)",
+  "BC1054 IR BCc": "BC-1054 IR BCc (ng/cm^{3}) (880 nm)"
+}

AeroViz/plot/violin.py

@@ -0,0 +1,79 @@
+import matplotlib.pyplot as plt
+import numpy as np
+import pandas as pd
+from matplotlib.pyplot import Figure, Axes
+from pandas import DataFrame
+
+from AeroViz.plot.utils import *
+
+__all__ = ['violin']
+
+
+@set_figure(fw='bold')
+def violin(data_set: DataFrame | dict,
+           unit: str,
+           ax: Axes | None = None,
+           **kwargs
+           ) -> tuple[Figure, Axes]:
+    """
+    Generate a violin plot for multiple data sets.
+
+    Parameters
+    ----------
+    data_set : pd.DataFrame or dict
+        A mapping from category names to pandas DataFrames containing the data.
+    unit : str
+        The unit for the data being plotted.
+    ax : matplotlib.axes.Axes, optional
+        The Axes object to draw the plot onto. If not provided, a new figure will be created.
+    **kwargs : dict
+        Additional keyword arguments to be passed to the violinplot function.
+
+    Returns
+    -------
+    matplotlib.axes.Axes
+        The Axes object containing the violin plot.
+
+    """
+    fig, ax = plt.subplots(**kwargs.get('fig_kws', {})) if ax is None else (ax.get_figure(), ax)
+
+    data = data_set.to_numpy()
+
+    data = data[~np.isnan(data).any(axis=1)]
+
+    grps = data.shape[1]
+
+    width = 0.6
+    block = width / 2
+    x_position = np.arange(grps)
+
+    plt.boxplot(data, positions=x_position, widths=0.15,
+                showfliers=False, showmeans=True, meanline=False, patch_artist=True,
+                capprops=dict(linewidth=0),
+                whiskerprops=dict(linewidth=1.5, color='k', alpha=1),
+                boxprops=dict(linewidth=1.5, color='k', facecolor='#4778D3', alpha=1),
+                meanprops=dict(marker='o', markeredgecolor='black', markerfacecolor='white', markersize=6),
+                medianprops=dict(linewidth=1.5, ls='-', color='k', alpha=1))
+
+    sns.violinplot(data=data, density_norm='area', color='#4778D3', inner=None)
+
+    for violin, alpha in zip(ax.collections[:], [0.5] * len(ax.collections[:])):
+        violin.set_alpha(alpha)
+        violin.set_edgecolor(None)
+
+    plt.scatter(x_position, data.mean(), marker='o', facecolor='white', edgecolor='k', s=10)
+
+    xlim = kwargs.get('xlim') or (x_position[0] - (width / 2 + block), x_position[-1] + (width / 2 + block))
+    ylim = kwargs.get('ylim') or (0, None)
+    xlabel = kwargs.get('xlabel') or ''
+    ylabel = kwargs.get('ylabel') or Unit(unit)
+    xticks = kwargs.get('xticks') or [x.replace('-', '\n') for x in list(data_set.keys())]
+
+    ax.set(xlim=xlim, ylim=ylim, xlabel=xlabel, ylabel=ylabel, title=kwargs.get('title'))
+    ax.set_xticks(x_position, xticks, fontweight='bold', fontsize=12)
+
+    # fig.savefig(f'Violin_{unit}')
+
+    plt.show()
+
+    return fig, ax