direl-ts-tool-kit 0.4.8__tar.gz → 0.5.0__tar.gz

direl_ts_tool_kit-0.5.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: direl-ts-tool-kit
+Version: 0.5.0
+Summary: A toolbox for time series analysis and visualization.
+Home-page: https://gitlab.com/direl/direl_tool_kit
+Author: Diego Restrepo-Leal
+Author-email: diegorestrepoleal@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: pandas>=1.0.0
+Requires-Dist: numpy>=1.18.0
+Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: openpyxl
+Requires-Dist: seaborn
+Requires-Dist: scipy
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# direl-ts-tool-kit
+> A Toolbox for Time Series Analysis and Visualization
+
+A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
+visualization with a consistent aesthetic style, and handling irregular indices.
+
+## Key features and functions
+
+The library provides the following key functionalities, primarily centered around data preparation and plotting.
+
+### Data preparation and index management
+#### parse_datetime_index
+`parse_datetime_index(df_raw, date_column="date", format=None)`
+
+Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+This function prepares raw data for time series analysis by ensuring the
+DataFrame is indexed by the correct datetime type.
+
+#### generate_dates
+`generate_dates(df_ts, freq="MS")`
+
+Generates a continuous DatetimeIndex covering the time span of the input DataFrame.
+
+The function determines the start and end dates from the existing DataFrame index
+and creates a new, regular date sequence based on the specified frequency.
+
+#### reindex_and_aggregate
+`reindex_and_aggregate(df_ts, column_name, freq="MS")`
+
+Re-indexes a time series DataFrame to a regular frequency, aggregates values,
+and introduces NaN for missing time steps.
+
+This function first identifies the time range from the original (potentially irregular)
+index, aggregates data if necessary (e.g., if multiple entries exist per time step),
+and then merges the data onto a complete date range, effectively filling gaps
+with NaN values.
+
+#### remove_outliers_by_threshold
+`remove_outliers_by_threshold(df_ts, column_name, lower_bound, upper_bound)`
+
+Replaces values in a specified column with NaN if they fall outside a defined range (outlier removal).
+
+This function identifies data points that are either below the lower
+bound or above the upper bound and treats them as missing data.
+
+
+### Visualization and styling
+
+#### plot_time_series
+`plot_time_series(df_ts, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, auto_format_label=True)`
+
+Plots a time series with custom styling and dual-level grid visibility.
+
+This function automatically sets major and minor time-based locators
+on the x-axis based on the specified time unit, and formats the y-axis
+to use scientific notation.
+
+#### save_figure
+`save_figure(fig, file_name, variable_name="", path="./")`
+
+Saves a Matplotlib figure in three common high-quality formats (PNG, PDF, SVG).
+
+The function creates a consistent file name structure:
+{path}/{file_name}_{variable_name}.{extension}.
+
+#### heat_map
+`heat_map(X, y, colors="Blues")`
+
+Generates a correlation heatmap plot for a set of features and a target variable.
+
+This function concatenates the feature DataFrame (X) and the target Series (y)
+to compute and visualize the full pairwise correlation matrix using Seaborn.
+
+#### pair_plot
+`pair_plot(X, y)`
+
+Generates a cornered pair plot (scatterplot matrix) to visualize relationships
+between features and the target variable.
+
+The function combines the feature DataFrame (X) and the target Series (y)
+and uses seaborn.pairplot to create a matrix of scatter plots and histograms.
+It focuses on the lower triangular part (corner=True) and includes a
+regression line for trend visualization.
+
+
+# Examples
+- [Example 1](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_01.md?ref_type=heads)
+- [Example 2](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_02.md?ref_type=heads)
+

direl_ts_tool_kit-0.5.0/README.md

@@ -0,0 +1,90 @@
+# direl-ts-tool-kit
+> A Toolbox for Time Series Analysis and Visualization
+
+A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
+visualization with a consistent aesthetic style, and handling irregular indices.
+
+## Key features and functions
+
+The library provides the following key functionalities, primarily centered around data preparation and plotting.
+
+### Data preparation and index management
+#### parse_datetime_index
+`parse_datetime_index(df_raw, date_column="date", format=None)`
+
+Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+This function prepares raw data for time series analysis by ensuring the
+DataFrame is indexed by the correct datetime type.
+
+#### generate_dates
+`generate_dates(df_ts, freq="MS")`
+
+Generates a continuous DatetimeIndex covering the time span of the input DataFrame.
+
+The function determines the start and end dates from the existing DataFrame index
+and creates a new, regular date sequence based on the specified frequency.
+
+#### reindex_and_aggregate
+`reindex_and_aggregate(df_ts, column_name, freq="MS")`
+
+Re-indexes a time series DataFrame to a regular frequency, aggregates values,
+and introduces NaN for missing time steps.
+
+This function first identifies the time range from the original (potentially irregular)
+index, aggregates data if necessary (e.g., if multiple entries exist per time step),
+and then merges the data onto a complete date range, effectively filling gaps
+with NaN values.
+
+#### remove_outliers_by_threshold
+`remove_outliers_by_threshold(df_ts, column_name, lower_bound, upper_bound)`
+
+Replaces values in a specified column with NaN if they fall outside a defined range (outlier removal).
+
+This function identifies data points that are either below the lower
+bound or above the upper bound and treats them as missing data.
+
+
+### Visualization and styling
+
+#### plot_time_series
+`plot_time_series(df_ts, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, auto_format_label=True)`
+
+Plots a time series with custom styling and dual-level grid visibility.
+
+This function automatically sets major and minor time-based locators
+on the x-axis based on the specified time unit, and formats the y-axis
+to use scientific notation.
+
+#### save_figure
+`save_figure(fig, file_name, variable_name="", path="./")`
+
+Saves a Matplotlib figure in three common high-quality formats (PNG, PDF, SVG).
+
+The function creates a consistent file name structure:
+{path}/{file_name}_{variable_name}.{extension}.
+
+#### heat_map
+`heat_map(X, y, colors="Blues")`
+
+Generates a correlation heatmap plot for a set of features and a target variable.
+
+This function concatenates the feature DataFrame (X) and the target Series (y)
+to compute and visualize the full pairwise correlation matrix using Seaborn.
+
+#### pair_plot
+`pair_plot(X, y)`
+
+Generates a cornered pair plot (scatterplot matrix) to visualize relationships
+between features and the target variable.
+
+The function combines the feature DataFrame (X) and the target Series (y)
+and uses seaborn.pairplot to create a matrix of scatter plots and histograms.
+It focuses on the lower triangular part (corner=True) and includes a
+regression line for trend visualization.
+
+
+# Examples
+- [Example 1](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_01.md?ref_type=heads)
+- [Example 2](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_02.md?ref_type=heads)
+

{direl_ts_tool_kit-0.4.8 → direl_ts_tool_kit-0.5.0}/direl_ts_tool_kit/plot/plot_style.py

@@ -1,3 +1,4 @@
+import seaborn as sns
 import matplotlib.pyplot as plt
 import matplotlib.dates as mdates
 

{direl_ts_tool_kit-0.4.8 → direl_ts_tool_kit-0.5.0}/direl_ts_tool_kit/plot/plot_ts.py

@@ -1,8 +1,16 @@
+import pandas as pd
 from .plot_style import *
+from scipy.stats import pearsonr
 
 
 def plot_time_series(
-    df_ts, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, auto_format_label=True
+    df_ts,
+    variable,
+    units="",
+    color="BLUE_LINES",
+    time_unit="Year",
+    rot=90,
+    auto_format_label=True,
 ):
     """
     Plots a time series with custom styling and dual-level grid visibility.
@@ -100,7 +108,7 @@ def plot_time_series(
     if time_unit == "Day":
         ax.xaxis.set_major_locator(mdates.DayLocator())
         ax.xaxis.set_minor_locator(mdates.HourLocator())
-        
+
     if time_unit == "Hour":
         ax.xaxis.set_major_locator(mdates.HourLocator())
         ax.xaxis.set_minor_locator(mdates.MinuteLocator())
@@ -151,3 +159,102 @@ def save_figure(
     fig.savefig(f"{base_name}.png")
     fig.savefig(f"{base_name}.pdf")
     fig.savefig(f"{base_name}.svg")
+
+
+def heat_map(X, y, colors="Blues"):
+    """
+    Generates a correlation heatmap plot for a set of features and a target variable.
+
+    This function concatenates the feature DataFrame (X) and the target Series (y)
+    to compute and visualize the full pairwise correlation matrix using Seaborn.
+
+    Parameters
+    ----------
+    X : pd.DataFrame
+        The DataFrame containing the feature variables.
+    y : pd.Series or pd.DataFrame
+        The target variable (must be concatenable with X).
+    colors : str or matplotlib.colors.Colormap, optional
+        The colormap to use for the heatmap, passed to the 'cmap' argument
+        in seaborn.heatmap. Defaults to "Blues".
+
+        Note: For standard correlation matrices (which include negative values),
+        a diverging colormap (e.g., "coolwarm", "vlag") is usually recommended.
+
+    Returns
+    -------
+    matplotlib.figure.Figure
+        The generated Matplotlib figure object containing the heatmap.
+
+    Notes
+    -----
+    The heatmap displays the Pearson correlation coefficient rounded to two
+    decimal places and includes annotations for improved readability.
+    """
+    fig, ax = plt.subplots()
+    Z = pd.concat([X, y], axis=1)
+
+    ax = sns.heatmap(
+        Z.corr(),
+        cmap=colors,
+        annot=True,
+        linewidths=0.5,
+        fmt=".2f",
+        annot_kws={"size": 10},
+    )
+
+    return fig
+
+
+def corrfunc(x, y, ax=None, **kws):
+    """Plot the correlation coefficient in the top left hand corner of a plot."""
+    r, _ = pearsonr(x, y)
+    ax = ax or plt.gca()
+    ax.annotate(f"R = {r:.2f}", xy=(0.1, 0.9), fontsize=25, xycoords=ax.transAxes)
+
+
+def pair_plot(X, y):
+    """
+    Generates a cornered pair plot (scatterplot matrix) to visualize relationships
+    between features and the target variable.
+
+    The function combines the feature DataFrame (X) and the target Series (y)
+    and uses seaborn.pairplot to create a matrix of scatter plots and histograms.
+    It focuses on the lower triangular part (corner=True) and includes a
+    regression line for trend visualization.
+
+    Parameters
+    ----------
+    X : pd.DataFrame
+        The DataFrame containing the feature variables.
+    y : pd.Series or pd.DataFrame
+        The target variable (must be concatenable with X).
+
+    Returns
+    -------
+    matplotlib.figure.Figure
+        The generated Matplotlib Figure object containing the cornered pair plot.
+
+    Notes
+    -----
+    1. **Dependency:** This function requires a previously defined custom function
+       `corrfunc` to be available in the local namespace, as it is used via
+       `svm.map_lower()`. This custom function is typically used to display
+       correlation coefficients (e.g., Pearson's r) in the lower panel.
+    2. **Aesthetics:** Uses a regression line (`kind="reg"`) with custom color
+       (RED_LINES) to highlight linear relationships.
+    3. **Output:** The returned Figure object can be manipulated further
+       or saved using methods like `fig.savefig()`.
+    """
+    Z = pd.concat([X, y], axis=1)
+    svm = sns.pairplot(
+        Z,
+        corner=True,
+        kind="reg",
+        plot_kws={"line_kws": {"color": paper_colors["RED_LINES"]}},
+    )
+    svm.map_lower(corrfunc)
+
+    fig = svm.fig
+
+    return fig

direl_ts_tool_kit-0.5.0/direl_ts_tool_kit.egg-info/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: direl-ts-tool-kit
+Version: 0.5.0
+Summary: A toolbox for time series analysis and visualization.
+Home-page: https://gitlab.com/direl/direl_tool_kit
+Author: Diego Restrepo-Leal
+Author-email: diegorestrepoleal@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: pandas>=1.0.0
+Requires-Dist: numpy>=1.18.0
+Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: openpyxl
+Requires-Dist: seaborn
+Requires-Dist: scipy
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# direl-ts-tool-kit
+> A Toolbox for Time Series Analysis and Visualization
+
+A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
+visualization with a consistent aesthetic style, and handling irregular indices.
+
+## Key features and functions
+
+The library provides the following key functionalities, primarily centered around data preparation and plotting.
+
+### Data preparation and index management
+#### parse_datetime_index
+`parse_datetime_index(df_raw, date_column="date", format=None)`
+
+Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+This function prepares raw data for time series analysis by ensuring the
+DataFrame is indexed by the correct datetime type.
+
+#### generate_dates
+`generate_dates(df_ts, freq="MS")`
+
+Generates a continuous DatetimeIndex covering the time span of the input DataFrame.
+
+The function determines the start and end dates from the existing DataFrame index
+and creates a new, regular date sequence based on the specified frequency.
+
+#### reindex_and_aggregate
+`reindex_and_aggregate(df_ts, column_name, freq="MS")`
+
+Re-indexes a time series DataFrame to a regular frequency, aggregates values,
+and introduces NaN for missing time steps.
+
+This function first identifies the time range from the original (potentially irregular)
+index, aggregates data if necessary (e.g., if multiple entries exist per time step),
+and then merges the data onto a complete date range, effectively filling gaps
+with NaN values.
+
+#### remove_outliers_by_threshold
+`remove_outliers_by_threshold(df_ts, column_name, lower_bound, upper_bound)`
+
+Replaces values in a specified column with NaN if they fall outside a defined range (outlier removal).
+
+This function identifies data points that are either below the lower
+bound or above the upper bound and treats them as missing data.
+
+
+### Visualization and styling
+
+#### plot_time_series
+`plot_time_series(df_ts, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, auto_format_label=True)`
+
+Plots a time series with custom styling and dual-level grid visibility.
+
+This function automatically sets major and minor time-based locators
+on the x-axis based on the specified time unit, and formats the y-axis
+to use scientific notation.
+
+#### save_figure
+`save_figure(fig, file_name, variable_name="", path="./")`
+
+Saves a Matplotlib figure in three common high-quality formats (PNG, PDF, SVG).
+
+The function creates a consistent file name structure:
+{path}/{file_name}_{variable_name}.{extension}.
+
+#### heat_map
+`heat_map(X, y, colors="Blues")`
+
+Generates a correlation heatmap plot for a set of features and a target variable.
+
+This function concatenates the feature DataFrame (X) and the target Series (y)
+to compute and visualize the full pairwise correlation matrix using Seaborn.
+
+#### pair_plot
+`pair_plot(X, y)`
+
+Generates a cornered pair plot (scatterplot matrix) to visualize relationships
+between features and the target variable.
+
+The function combines the feature DataFrame (X) and the target Series (y)
+and uses seaborn.pairplot to create a matrix of scatter plots and histograms.
+It focuses on the lower triangular part (corner=True) and includes a
+regression line for trend visualization.
+
+
+# Examples
+- [Example 1](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_01.md?ref_type=heads)
+- [Example 2](https://gitlab.com/direl/direl_tool_kit/-/blob/main/example/example_02.md?ref_type=heads)
+

{direl_ts_tool_kit-0.4.8 → direl_ts_tool_kit-0.5.0}/direl_ts_tool_kit.egg-info/requires.txt

@@ -2,3 +2,5 @@ pandas>=1.0.0
 numpy>=1.18.0
 matplotlib>=3.0.0
 openpyxl
+seaborn
+scipy

{direl_ts_tool_kit-0.4.8 → direl_ts_tool_kit-0.5.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="direl-ts-tool-kit",
-    version="0.4.8",
+    version="0.5.0",
     description="A toolbox for time series analysis and visualization.",
     long_description=open("README.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",
@@ -15,6 +15,8 @@ setup(
         "numpy>=1.18.0",
         "matplotlib>=3.0.0",
         "openpyxl",
+        "seaborn",
+        "scipy"
     ],
     classifiers=[
         "Programming Language :: Python :: 3",