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

AeroViz/dataProcess/__init__.py

@@ -1,11 +1,33 @@
+from pathlib import Path
+
 from .Chemistry import Chemistry
 from .Optical import Optical
 from .SizeDistr import SizeDistr
 from .VOC import VOC
 
-__all__ = [
-    'Optical',
-    'SizeDistr',
-    'Chemistry',
-    'VOC',
-]
+__all__ = ['DataProcess']
+
+
+def DataProcess(method: str,
+                path_out: Path,
+                excel: bool = False,
+                csv: bool = True,
+                ):
+    # Mapping of method names to their respective classes
+    method_class_map = {
+        'Chemistry': Chemistry,
+        'Optical': Optical,
+        'SizeDistr': SizeDistr,
+        'VOC': VOC
+    }
+
+    if method not in method_class_map.keys():
+        raise ValueError(f"Method name '{method}' is not valid. \nMust be one of: {list(method_class_map.keys())}")
+
+    writer_module = method_class_map[method](
+        path_out=path_out,
+        excel=excel,
+        csv=csv
+    )
+
+    return writer_module

AeroViz/dataProcess/core/__init__.py

@@ -5,17 +5,16 @@ from pathlib import Path
 from pandas import concat
 
 
-class _writter:
+class Writer:
 
     def __init__(self, path_out=None, excel=True, csv=False):
-
         self.path_out = Path(path_out) if path_out is not None else path_out
         self.excel = excel
         self.csv = csv
 
-    def _pre_process(self, _out):
-
-        if type(_out) == dict:
+    @staticmethod
+    def pre_process(_out):
+        if isinstance(_out, dict):
             for _ky, _df in _out.items():
                 _df.index.name = 'time'
         else:
@@ -23,8 +22,7 @@ class _writter:
 
         return _out
 
-    def _save_out(self, _nam, _out):
-
+    def save_out(self, _nam, _out):
         _check = True
         while _check:
 
@@ -44,7 +42,7 @@ class _writter:
                                 _out.to_excel(f, sheet_name=f'{_nam}')
 
                     if self.csv:
-                        if type(_out) == dict:
+                        if isinstance(_out, dict):
                             _path_out = self.path_out / _nam
                             _path_out.mkdir(exist_ok=True, parents=True)
 
@@ -60,7 +58,7 @@ class _writter:
                 input('\t\t\33[41m Please Close The File And Press "Enter" \33[0m\n')
 
 
-def _run_process(*_ini_set):
+def run_process(*_ini_set):
     def _decorator(_prcs_fc):
         def _wrap(*arg, **kwarg):
             _fc_name, _nam = _ini_set
@@ -71,9 +69,9 @@ def _run_process(*_ini_set):
             print(f"\n\t{dtm.now().strftime('%m/%d %X')} : Process \033[92m{_fc_name}\033[0m -> {_nam}")
 
             _class, _out = _prcs_fc(*arg, **kwarg)
-            _out = _class._pre_process(_out)
+            _out = _class.pre_process(_out)
 
-            _class._save_out(_nam, _out)
+            _class.save_out(_nam, _out)
 
             return _out
 
@@ -82,12 +80,7 @@ def _run_process(*_ini_set):
     return _decorator
 
 
-def _union_index(*_df_arg):
+def union_index(*_df_arg):
     _idx = concat(_df_arg, axis=1).index
 
-    # _idx = DatetimeIndex([])
-
-    # for _df in _df_arg:
-    # _idx = _idx.union(DataFrame(_df).index)
-
     return [_df.reindex(_idx) if _df is not None else None for _df in _df_arg]

AeroViz/plot/__init__.py

@@ -1,12 +1,12 @@
 from . import distribution
 from . import meteorology
 from . import optical
-from . import timeseries
 from .bar import bar
 from .box import box
 from .pie import pie, donuts
 from .regression import linear_regression, multiple_linear_regression
 from .scatter import scatter
 from .templates import *
+from .timeseries import timeseries, timeseries_template, timeseries_stacked
 from .utils import *
 from .violin import violin

AeroViz/plot/box.py

@@ -15,7 +15,8 @@ def box(df: pd.DataFrame,
         x_bins: list | np.ndarray = None,
         add_scatter: bool = True,
         ax: Axes | None = None,
-        **kwargs) -> tuple[Figure, Axes]:
+        **kwargs
+        ) -> tuple[Figure, Axes]:
     fig, ax = plt.subplots(**kwargs.get('fig_kws', {})) if ax is None else (ax.get_figure(), ax)
 
     df = df.dropna(subset=[x, y]).copy()

AeroViz/plot/optical/optical.py

@@ -381,8 +381,8 @@ def response_surface(real_range=(1.33, 1.7),
 
 
 if __name__ == '__main__':
-    Q_plot(['AS', 'AN', 'OM', 'Soil', 'SS', 'BC'], x='dp', y='MEE')
-    Q_plot(['AS', 'AN', 'OM', 'Soil', 'SS', 'BC'], x='dp', y='Q')
+    # Q_plot(['AS', 'AN', 'OM', 'Soil', 'SS', 'BC'], x='dp', y='MEE')
+    # Q_plot(['AS', 'AN', 'OM', 'Soil', 'SS', 'BC'], x='dp', y='Q')
 
-# RI_couple()
-# response_surface()
+    # RI_couple()
+    response_surface()

AeroViz/plot/regression.py

@@ -23,53 +23,47 @@ def linear_regression(df: pd.DataFrame,
                       **kwargs
                       ) -> tuple[Figure, Axes]:
     """
-    Create a scatter plot with multiple regression lines for the given data.
+    Create a scatter plot with regression lines for the given data.
 
     Parameters
     ----------
-    df : DataFrame
+    df : pd.DataFrame
         Input DataFrame containing the data.
-
     x : str or list of str
-        Column name(s) for the x-axis variable(s).
-
+        Column name(s) for the x-axis variable(s). If a list, only the first element is used.
     y : str or list of str
         Column name(s) for the y-axis variable(s).
-
     labels : str or list of str, optional
         Labels for the y-axis variable(s). If None, column names are used as labels. Default is None.
-
-    ax : AxesSubplot, optional
-        Matplotlib AxesSubplot to use for the plot. If None, a new subplot is created. Default is None.
-
+    ax : Axes, optional
+        Matplotlib Axes object to use for the plot. If None, a new subplot is created. Default is None.
     diagonal : bool, optional
         If True, a diagonal line (1:1 line) is added to the plot. Default is False.
-
     positive : bool, optional
-       Whether to let coefficient positive. Default is True.
-
+        Whether to constrain the regression coefficients to be positive. Default is True.
     fit_intercept: bool, optional
-        Whether to fit intercept. Default is True.
-
+        Whether to calculate the intercept for this model. Default is True.
     **kwargs
-        Additional keyword arguments to customize the plot.
+        Additional keyword arguments for plot customization.
 
     Returns
     -------
-    AxesSubplot
-        Matplotlib AxesSubplot containing the scatter plot.
+    fig : Figure
+        The matplotlib Figure object.
+    ax : Axes
+        The matplotlib Axes object with the scatter plot.
 
     Notes
     -----
-    - The function creates a scatter plot with the option to include multiple regression lines.
-    - If regression is True, regression lines are fitted for each y variable.
-    - Additional customization can be done using the **kwargs.
+    - The function creates a scatter plot with optional regression lines.
+    - The regression line is fitted for each y variable.
+    - Customization options are provided via **kwargs.
 
     Example
     -------
     >>> linear_regression(df, x='X', y=['Y1', 'Y2'], labels=['Label1', 'Label2'],
-    ...                      regression=True, diagonal=True, xlim=(0, 10), ylim=(0, 20),
-    ...                      xlabel="X-axis", ylabel="Y-axis", title="Scatter Plot with Regressions")
+    ...                  diagonal=True, xlim=(0, 10), ylim=(0, 20),
+    ...                  xlabel="X-axis", ylabel="Y-axis", title="Scatter Plot with Regressions")
     """
     fig, ax = plt.subplots(**kwargs.get('fig_kws', {})) if ax is None else (ax.get_figure(), ax)
 
@@ -140,37 +134,29 @@ def multiple_linear_regression(df: pd.DataFrame,
 
     Parameters
     ----------
-    df : pandas.DataFrame
+    df : pd.DataFrame
        Input DataFrame containing the data.
-
     x : str or list of str
        Column name(s) for the independent variable(s). Can be a single string or a list of strings.
-
     y : str or list of str
        Column name(s) for the dependent variable(s). Can be a single string or a list of strings.
-
     labels : str or list of str, optional
        Labels for the dependent variable(s). If None, column names are used as labels. Default is None.
-
-    ax : matplotlib.axes.Axes or None, optional
+    ax : Axes, optional
        Matplotlib Axes object to use for the plot. If None, a new subplot is created. Default is None.
-
     diagonal : bool, optional
        Whether to include a diagonal line (1:1 line) in the plot. Default is False.
-
     positive : bool, optional
-       Whether to let coefficient positive. Default is True.
-
+       Whether to constrain the regression coefficients to be positive. Default is True.
     fit_intercept: bool, optional
-        Whether to fit intercept. Default is True.
-
+        Whether to calculate the intercept for this model. Default is True.
     **kwargs
-       Additional keyword arguments to customize the plot.
+       Additional keyword arguments for plot customization.
 
     Returns
     -------
-    matplotlib.axes.Axes
-       Matplotlib Axes object containing the regression plot.
+    tuple[Figure, Axes]
+       The Figure and Axes containing the regression plot.
 
     Notes
     -----
@@ -180,7 +166,7 @@ def multiple_linear_regression(df: pd.DataFrame,
     Example
     -------
     >>> multiple_linear_regression(df, x=['X1', 'X2'], y='Y', labels=['Y1', 'Y2'],
-    ...                             diagonal=True, add_constant=True,
+    ...                             diagonal=True, fit_intercept=True,
     ...                             xlabel="X-axis", ylabel="Y-axis", title="Multiple Linear Regression Plot")
     """
     fig, ax = plt.subplots(**kwargs.get('fig_kws', {})) if ax is None else (ax.get_figure(), ax)

AeroViz/plot/scatter.py

@@ -11,7 +11,13 @@ from AeroViz.plot.utils import *
 __all__ = ['scatter']
 
 
-@set_figure(figsize=(5, 4))
+def check_empty(*arrays):
+    for i, arr in enumerate(arrays):
+        if arr.size == 0:
+            raise ValueError(f"Array is empty!")
+
+
+@set_figure
 def scatter(df: pd.DataFrame,
             x: str,
             y: str,
@@ -21,12 +27,69 @@ def scatter(df: pd.DataFrame,
             regression=False,
             diagonal=False,
             ax: Axes | None = None,
-            **kwargs) -> tuple[Figure, Axes]:
+            **kwargs
+            ) -> tuple[Figure, Axes]:
+    """
+    Creates a scatter plot with optional color and size encoding.
+
+    Parameters
+    ----------
+    df : pd.DataFrame
+        The DataFrame containing the data to plot.
+    x : str
+        The column name for the x-axis values.
+    y : str
+        The column name for the y-axis values.
+    c : str, optional
+        The column name for color encoding. Default is None.
+    s : str, optional
+        The column name for size encoding. Default is None.
+    cmap : str, optional
+        The colormap to use for the color encoding. Default is 'jet'.
+    regression : bool, optional
+        If True, fits and plots a linear regression line. Default is False.
+    diagonal : bool, optional
+        If True, plots a 1:1 diagonal line. Default is False.
+    ax : Axes, optional
+        The matplotlib Axes to plot on. If not provided, a new figure and axes are created.
+    **kwargs : Any
+        Additional keyword arguments passed to customize the plot, such as `fig_kws` for figure creation and `xlabel`,
+        `ylabel`, `xlim`, `ylim`, `title` for axis labeling and limits.
+
+    Returns
+    -------
+    fig : Figure
+        The matplotlib Figure object.
+    ax : Axes
+        The matplotlib Axes object with the scatter plot.
+
+    Notes
+    -----
+    - If both `c` and `s` are provided, the scatter plot will encode data points using both color and size.
+    - If only `c` is provided, data points will be color-coded according to the values in the `c` column.
+    - If only `s` is provided, data points will be sized according to the values in the `s` column.
+    - If neither `c` nor `s` is provided, a basic scatter plot is created.
+    - The `regression` option will add a linear regression line and display the equation on the plot.
+    - The `diagonal` option will add a 1:1 reference line to the plot.
+
+    Examples
+    --------
+    >>> import pandas as pd
+    >>> from AeroViz.plot import scatter
+    >>> df = pd.DataFrame({
+    >>>     'x': [1, 2, 3, 4],
+    >>>     'y': [1.1, 2.0, 2.9, 4.1],
+    >>>     'color': [10, 20, 30, 40],
+    >>>     'size': [100, 200, 300, 400]
+    >>> })
+    >>> fig, ax = scatter(df, x='x', y='y', c='color', s='size', regression=True, diagonal=True)
+    """
     fig, ax = plt.subplots(**kwargs.get('fig_kws', {})) if ax is None else (ax.get_figure(), ax)
 
     if c is not None and s is not None:
         df_ = df.dropna(subset=[x, y, c, s]).copy()
         x_data, y_data, c_data, s_data = df_[x].to_numpy(), df_[y].to_numpy(), df_[c].to_numpy(), df_[s].to_numpy()
+        check_empty(x_data, y_data, c_data, s_data)
 
         scatter = ax.scatter(x_data, y_data, c=c_data,
                              norm=Normalize(vmin=np.percentile(c_data, 10), vmax=np.percentile(c_data, 90)),
@@ -43,6 +106,7 @@ def scatter(df: pd.DataFrame,
     elif c is not None:
         df_ = df.dropna(subset=[x, y, c]).copy()
         x_data, y_data, c_data = df_[x].to_numpy(), df_[y].to_numpy(), df_[c].to_numpy()
+        check_empty(x_data, y_data, c_data)
 
         scatter = ax.scatter(x_data, y_data, c=c_data, vmin=c_data.min(), vmax=np.percentile(c_data, 90), cmap=cmap,
                              alpha=0.7,
@@ -52,6 +116,7 @@ def scatter(df: pd.DataFrame,
     elif s is not None:
         df_ = df.dropna(subset=[x, y, s]).copy()
         x_data, y_data, s_data = df_[x].to_numpy(), df_[y].to_numpy(), df_[s].to_numpy()
+        check_empty(x_data, y_data, s_data)
 
         scatter = ax.scatter(x_data, y_data, s=50 * (s_data / s_data.max()) ** 1.5, color='#7a97c9', alpha=0.7,
                              edgecolors='white')
@@ -68,6 +133,7 @@ def scatter(df: pd.DataFrame,
     else:
         df_ = df.dropna(subset=[x, y]).copy()
         x_data, y_data = df_[x].to_numpy(), df_[y].to_numpy()
+        check_empty(x_data, y_data)
 
         scatter = ax.scatter(x_data, y_data, s=30, color='#7a97c9', alpha=0.7, edgecolors='white')
         colorbar = False

AeroViz/plot/templates/__init__.py

@@ -1,5 +1,6 @@
+from .ammonium_rich import ammonium_rich
 from .contour import *
 from .corr_matrix import corr_matrix
 from .diurnal_pattern import *
 from .koschmieder import *
-from .metal_heatmap import metal_heatmaps, process_data
+from .metal_heatmap import metal_heatmaps, process_data_with_two_df

AeroViz/plot/templates/ammonium_rich.py

@@ -0,0 +1,34 @@
+import matplotlib.pyplot as plt
+from matplotlib.pyplot import Figure, Axes
+from pandas import DataFrame
+
+from AeroViz.plot.utils import set_figure, Unit
+
+
+@set_figure(figsize=(5, 4))
+def ammonium_rich(df: DataFrame,
+                  **kwargs
+                  ) -> tuple[Figure, Axes]:
+    df = df[['NH4+', 'SO42-', 'NO3-', 'PM2.5']].dropna().copy().div([18, 96, 62, 1])
+    df['required_ammonium'] = df['NO3-'] + 2 * df['SO42-']
+
+    fig, ax = plt.subplots()
+
+    scatter = ax.scatter(df['required_ammonium'].to_numpy(), df['NH4+'].to_numpy(), c=df['PM2.5'].to_numpy(),
+                         vmin=0, vmax=70, cmap='jet', marker='o', s=10, alpha=1)
+
+    ax.axline((0, 0), slope=1., color='k', lw=2, ls='--', alpha=0.5, label='1:1')
+    plt.text(0.97, 0.97, r'$\bf 1:1\ Line$', color='k', ha='right', va='top', transform=ax.transAxes)
+
+    ax.set(xlim=(0, 1.2),
+           ylim=(0, 1.2),
+           xlabel=r'$\bf NO_{3}^{-}\ +\ 2\ \times\ SO_{4}^{2-}\ (mole\ m^{-3})$',
+           ylabel=r'$\bf NH_{4}^{+}\ (mole\ m^{-3})$',
+           title=kwargs.get('title', ''))
+
+    color_bar = plt.colorbar(scatter, label=Unit('PM2.5'), extend='both')
+
+    # fig.savefig(f'Ammonium_rich_{title}')
+    plt.show()
+
+    return fig, ax

AeroViz/plot/templates/diurnal_pattern.py

@@ -1,7 +1,7 @@
 import matplotlib.pyplot as plt
-import pandas as pd
 from matplotlib.pyplot import Figure, Axes
 from matplotlib.ticker import AutoMinorLocator
+from pandas import DataFrame
 
 from AeroViz.plot.utils import *
 
@@ -9,22 +9,24 @@ __all__ = ['diurnal_pattern']
 
 
 @set_figure
-def diurnal_pattern(data_set: pd.DataFrame,
-                    data_std: pd.DataFrame,
+def diurnal_pattern(df: DataFrame,
                     y: str | list[str],
-                    std_area=0.5,
+                    std_area: float = 0.5,
                     ax: Axes | None = None,
-                    **kwargs) -> tuple[Figure, Axes]:
-    fig, ax = plt.subplots(**kwargs.get('fig_kws', {})) if ax is None else (ax.get_figure(), ax)
+                    **kwargs
+                    ) -> tuple[Figure, Axes]:
+    if 'hour' or 'Hour' not in df.columns:
+        df['Hour'] = df.index.hour
 
     Hour = range(0, 24)
+    mean = df.groupby('Hour')[y].mean()
+    std = df.groupby('Hour')[y].std() * std_area
 
-    mean = data_set[y]
-    std = data_std[y] * std_area
+    fig, ax = plt.subplots(**kwargs.get('fig_kws', {})) if ax is None else (ax.get_figure(), ax)
 
     # Plot Diurnal pattern
     ax.plot(Hour, mean, 'blue')
-    ax.fill_between(Hour, y1=mean + std, y2=mean - std, alpha=0.5, color='blue', edgecolor=None)
+    ax.fill_between(Hour, y1=mean + std, y2=mean - std, alpha=0.2, color='blue', edgecolor=None)
 
     ax.set(xlabel=kwargs.get('xlabel', 'Hours'),
            ylabel=kwargs.get('ylabel', Unit(y)),