sgwt 0.3.3__tar.gz → 0.3.6__tar.gz

{sgwt-0.3.3/sgwt.egg-info → sgwt-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sgwt
-Version: 0.3.3
+Version: 0.3.6
 Summary: Sparse Tools for the Spectral Graph Wavelet Transformation and Graph Convolution
 Author-email: Luke Lowery <lukel@tamu.edu>
 Project-URL: Homepage, https://github.com/lukelowry/sgwt
@@ -18,6 +18,10 @@ Requires-Dist: scipy
 Requires-Dist: importlib-resources>=5.0; python_version < "3.9"
 Provides-Extra: dev
 Requires-Dist: matplotlib; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-benchmark; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
@@ -28,86 +32,82 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Dynamic: license-file
 
-Sparse SGWT
+Sparse Graph Convolution
 ====================================
 
-.. image:: https://img.shields.io/pypi/v/sgwt.svg
-    :target: https://pypi.org/project/sgwt/
-    :alt: PyPI Version
+.. |pypi| image:: https://img.shields.io/pypi/v/sgwt.svg
+   :target: https://pypi.org/project/sgwt/
+   :alt: PyPI Version
 
-.. image:: https://img.shields.io/pypi/pyversions/sgwt.svg
-    :target: https://pypi.org/project/sgwt/
-    :alt: Python Version
+.. |python| image:: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue.svg
+   :target: https://pypi.org/project/sgwt/
+   :alt: Python Version
 
-.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
-    :target: ./LICENSE.md
-    :alt: License
+.. |license| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
+   :target: ./LICENSE.md
+   :alt: License
+
+.. |coverage| image:: https://img.shields.io/badge/coverage-100%25-brightgreen.svg
+   :alt: Coverage
+
+|pypi| |python| |license| |coverage|
 
 A high-performance Python library for sparse Graph Signal Processing (GSP) and Spectral Graph Wavelet Transforms (SGWT). This package leverages the ``CHOLMOD`` library for efficient sparse direct solvers, providing significant speedups over traditional dense or iterative methods for large-scale graph convolution.
 
-Key Features
-------------
+Some of the key features include:
+
 
 - **High-Performance Sparse Solvers**: Direct integration with the ``CHOLMOD`` library for optimized sparse Cholesky factorizations and linear system solves.
-- **Generalized Graph Convolution**: Support for arbitrary spectral kernels via polynomial approximation (Chebyshev) and standard analytical filters (low-pass, band-pass, high-pass).
+- **Generalized Graph Convolution**: Support for arbitrary spectral kernels via rational approximation (Kernel Fitting), polynomial approximation (Chebyshev), and standard analytical filters (low-pass, band-pass, high-pass).
 - **Dynamic Topology Support**: Specialized routines for graphs with evolving structures, utilizing efficient rank-1 updates for real-time topology changes.
 - **Resource-Aware Execution**: Context-managed memory allocation and workspace reuse to minimize overhead in high-throughput applications.
 - **Integrated Graph Repository**: Built-in access to standardized graph Laplacians and signals from power systems and infrastructure networks.
 
+For detailed usage, API reference, and theoretical background, please visit the `documentation website <https://sgwt.readthedocs.io/>`_.
+
 Installation
 ------------
 
-You can install ``sgwt`` from the `Python Package Index (PyPI) <https://pypi.org/project/sgwt/>`_:
+The ``sgwt`` package requires Python 3.7+ and is currently only compatible with **Windows** operating systems due to its reliance on a pre-compiled ``CHOLMOD`` library.
+
+Install the latest stable release from `PyPI <https://pypi.org/project/sgwt/>`_:
 
 .. code-block:: bash
 
     pip install sgwt
 
-Usage Example
+This command will also install the necessary dependencies (e.g., NumPy, SciPy).
+
+Basic Example
 -------------
 
-Here is a quick example of applying a band-pass filter to an impulse signal on the built-in Texas grid Laplacian.
+Here is a quick example using a band-pass filter to an impulse signal on the synthetic Texas grid to get the wavelet function at three different scales.
+
 
 .. code-block:: python
 
     import sgwt
 
-    # 1. Load a built-in graph Laplacian, which defines the graph's topology.
+    # Graph Laplacian
     L = sgwt.DELAY_TEXAS
 
-    # 2. Create a vertex-domain signal. Here, a Dirac impulse on the 600th vertex.
-    #    The `impulse` helper function ensures the required column-major memory order.
-    signal = sgwt.impulse(L, n=600)
+    # Impulse at 600th Vertex
+    X = sgwt.impulse(L, n=600)
 
-    # 3. Use the static convolution context manager. This performs a one-time
-    #    symbolic factorization of the Laplacian for efficient repeated solves.
     with sgwt.Convolve(L) as conv:
-        # 4. Apply an analytical band-pass filter. The scale parameter controls
-        #    the filter's center frequency.
-        filtered_signals = conv.bandpass(signal, scales=[10.0])
-
-    # 5. The result is a list of filtered signals, one for each input scale.
-    result = filtered_signals[0]
+        
+        # Wavelet at 3 scales
+        Y = conv.bandpass(X, scales=[0.1, 1, 10])
 
-    print(f"Graph has {L.shape[0]} vertices.")
-    print(f"Signal on vertex 600, shape: {signal.shape}")
-    print(f"Filtered signal shape: {result.shape}")
-
-Examples
---------
 
 The `examples/ <https://github.com/lukelowry/sgwt/tree/main/examples>`_ directory contains a comprehensive suite of demonstrations, also rendered in the `Examples <https://sgwt.readthedocs.io/en/stable/examples/static.html>`_ section of the documentation. Key applications include:
 
 - **Static Filtering**: Basic low-pass, band-pass, and high-pass filtering on various graph sizes.
 - **Dynamic Graphs**: Real-time topology updates, performance comparisons, and online stream processing.
 
-Documentation
--------------
 
-For detailed usage, API reference, and theoretical background, please visit the `documentation website <https://sgwt.readthedocs.io/en/stable/>`_.
-
-Citation
---------
+Citation & Acknowledgements
+---------------------------
 
 If you use this library in your research, please cite it. The `GitHub repository <https://github.com/lukelowry/sgwt>`_ includes a ``CITATION.cff`` file that provides citation metadata. On GitHub, you can use the "Cite this repository" button on the sidebar to get the citation in your preferred format (including BibTeX).
 
@@ -115,20 +115,15 @@ For convenience, the BibTeX entry for the associated paper is:
 
 .. code-block:: bibtex
 
-    @inproceedings{lowery-sgwt-YYYY,
+    @inproceedings{lowery-sgwt-2026,
       title={Using Spectral Graph Wavelets to Analyze Large Power System Oscillation Modes},
       author={Lowery, Luke and Baek, Jongoh and Birchfield, Adam},
-      year={YYYY}
+      year={2026}
     }
 
-Author
-
-This module was developed by Luke Lowery during his PhD studies at Texas A&M University. You can learn more on his `research page <https://lukelowry.github.io/>`_ or view his publications on `Google Scholar <https://scholar.google.com/citations?user=CTynuRMAAAAJ&hl=en>`_.
-
-An alternative implementation in `Julia <https://github.com/lukelowry/SpectralGraphWavelet.jl>`_ is also available, which takes advantage of native SuiteSparse support.
+Luke Lowery developed this module during his PhD studies at Texas A&M University. You can learn more on his `research page <https://lukelowry.github.io/>`_ or view his publications on `Google Scholar <https://scholar.google.com/citations?user=CTynuRMAAAAJ&hl=en>`_.
 
-Acknowledgements
-----------------
+An alternative implementation in `Julia <https://github.com/lukelowry/SpectralGraphWavelet.jl>`_ is also available and leverages native SuiteSparse support.
 
 - The core performance of this library relies on the ``CHOLMOD`` library from `SuiteSparse <https://github.com/DrTimothyAldenDavis/SuiteSparse>`_, developed by Dr. Tim Davis at Texas A&M University.
 - The graph laplacians used in the examples are derived from the `synthetic grid repository <https://electricgrids.engr.tamu.edu/electric-grid-test-cases/>`_, made available by Dr. Adam Birchfield at Texas A&M University.

{sgwt-0.3.3 → sgwt-0.3.6}/README.rst

@@ -1,83 +1,79 @@
-Sparse SGWT
+Sparse Graph Convolution
 ====================================
 
-.. image:: https://img.shields.io/pypi/v/sgwt.svg
-    :target: https://pypi.org/project/sgwt/
-    :alt: PyPI Version
+.. |pypi| image:: https://img.shields.io/pypi/v/sgwt.svg
+   :target: https://pypi.org/project/sgwt/
+   :alt: PyPI Version
 
-.. image:: https://img.shields.io/pypi/pyversions/sgwt.svg
-    :target: https://pypi.org/project/sgwt/
-    :alt: Python Version
+.. |python| image:: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue.svg
+   :target: https://pypi.org/project/sgwt/
+   :alt: Python Version
 
-.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
-    :target: ./LICENSE.md
-    :alt: License
+.. |license| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
+   :target: ./LICENSE.md
+   :alt: License
+
+.. |coverage| image:: https://img.shields.io/badge/coverage-100%25-brightgreen.svg
+   :alt: Coverage
+
+|pypi| |python| |license| |coverage|
 
 A high-performance Python library for sparse Graph Signal Processing (GSP) and Spectral Graph Wavelet Transforms (SGWT). This package leverages the ``CHOLMOD`` library for efficient sparse direct solvers, providing significant speedups over traditional dense or iterative methods for large-scale graph convolution.
 
-Key Features
-------------
+Some of the key features include:
+
 
 - **High-Performance Sparse Solvers**: Direct integration with the ``CHOLMOD`` library for optimized sparse Cholesky factorizations and linear system solves.
-- **Generalized Graph Convolution**: Support for arbitrary spectral kernels via polynomial approximation (Chebyshev) and standard analytical filters (low-pass, band-pass, high-pass).
+- **Generalized Graph Convolution**: Support for arbitrary spectral kernels via rational approximation (Kernel Fitting), polynomial approximation (Chebyshev), and standard analytical filters (low-pass, band-pass, high-pass).
 - **Dynamic Topology Support**: Specialized routines for graphs with evolving structures, utilizing efficient rank-1 updates for real-time topology changes.
 - **Resource-Aware Execution**: Context-managed memory allocation and workspace reuse to minimize overhead in high-throughput applications.
 - **Integrated Graph Repository**: Built-in access to standardized graph Laplacians and signals from power systems and infrastructure networks.
 
+For detailed usage, API reference, and theoretical background, please visit the `documentation website <https://sgwt.readthedocs.io/>`_.
+
 Installation
 ------------
 
-You can install ``sgwt`` from the `Python Package Index (PyPI) <https://pypi.org/project/sgwt/>`_:
+The ``sgwt`` package requires Python 3.7+ and is currently only compatible with **Windows** operating systems due to its reliance on a pre-compiled ``CHOLMOD`` library.
+
+Install the latest stable release from `PyPI <https://pypi.org/project/sgwt/>`_:
 
 .. code-block:: bash
 
     pip install sgwt
 
-Usage Example
+This command will also install the necessary dependencies (e.g., NumPy, SciPy).
+
+Basic Example
 -------------
 
-Here is a quick example of applying a band-pass filter to an impulse signal on the built-in Texas grid Laplacian.
+Here is a quick example using a band-pass filter to an impulse signal on the synthetic Texas grid to get the wavelet function at three different scales.
+
 
 .. code-block:: python
 
     import sgwt
 
-    # 1. Load a built-in graph Laplacian, which defines the graph's topology.
+    # Graph Laplacian
     L = sgwt.DELAY_TEXAS
 
-    # 2. Create a vertex-domain signal. Here, a Dirac impulse on the 600th vertex.
-    #    The `impulse` helper function ensures the required column-major memory order.
-    signal = sgwt.impulse(L, n=600)
+    # Impulse at 600th Vertex
+    X = sgwt.impulse(L, n=600)
 
-    # 3. Use the static convolution context manager. This performs a one-time
-    #    symbolic factorization of the Laplacian for efficient repeated solves.
     with sgwt.Convolve(L) as conv:
-        # 4. Apply an analytical band-pass filter. The scale parameter controls
-        #    the filter's center frequency.
-        filtered_signals = conv.bandpass(signal, scales=[10.0])
-
-    # 5. The result is a list of filtered signals, one for each input scale.
-    result = filtered_signals[0]
+        
+        # Wavelet at 3 scales
+        Y = conv.bandpass(X, scales=[0.1, 1, 10])
 
-    print(f"Graph has {L.shape[0]} vertices.")
-    print(f"Signal on vertex 600, shape: {signal.shape}")
-    print(f"Filtered signal shape: {result.shape}")
-
-Examples
---------
 
 The `examples/ <https://github.com/lukelowry/sgwt/tree/main/examples>`_ directory contains a comprehensive suite of demonstrations, also rendered in the `Examples <https://sgwt.readthedocs.io/en/stable/examples/static.html>`_ section of the documentation. Key applications include:
 
 - **Static Filtering**: Basic low-pass, band-pass, and high-pass filtering on various graph sizes.
 - **Dynamic Graphs**: Real-time topology updates, performance comparisons, and online stream processing.
 
-Documentation
--------------
 
-For detailed usage, API reference, and theoretical background, please visit the `documentation website <https://sgwt.readthedocs.io/en/stable/>`_.
-
-Citation
---------
+Citation & Acknowledgements
+---------------------------
 
 If you use this library in your research, please cite it. The `GitHub repository <https://github.com/lukelowry/sgwt>`_ includes a ``CITATION.cff`` file that provides citation metadata. On GitHub, you can use the "Cite this repository" button on the sidebar to get the citation in your preferred format (including BibTeX).
 
@@ -85,20 +81,15 @@ For convenience, the BibTeX entry for the associated paper is:
 
 .. code-block:: bibtex
 
-    @inproceedings{lowery-sgwt-YYYY,
+    @inproceedings{lowery-sgwt-2026,
       title={Using Spectral Graph Wavelets to Analyze Large Power System Oscillation Modes},
       author={Lowery, Luke and Baek, Jongoh and Birchfield, Adam},
-      year={YYYY}
+      year={2026}
     }
 
-Author
-
-This module was developed by Luke Lowery during his PhD studies at Texas A&M University. You can learn more on his `research page <https://lukelowry.github.io/>`_ or view his publications on `Google Scholar <https://scholar.google.com/citations?user=CTynuRMAAAAJ&hl=en>`_.
-
-An alternative implementation in `Julia <https://github.com/lukelowry/SpectralGraphWavelet.jl>`_ is also available, which takes advantage of native SuiteSparse support.
+Luke Lowery developed this module during his PhD studies at Texas A&M University. You can learn more on his `research page <https://lukelowry.github.io/>`_ or view his publications on `Google Scholar <https://scholar.google.com/citations?user=CTynuRMAAAAJ&hl=en>`_.
 
-Acknowledgements
-----------------
+An alternative implementation in `Julia <https://github.com/lukelowry/SpectralGraphWavelet.jl>`_ is also available and leverages native SuiteSparse support.
 
 - The core performance of this library relies on the ``CHOLMOD`` library from `SuiteSparse <https://github.com/DrTimothyAldenDavis/SuiteSparse>`_, developed by Dr. Tim Davis at Texas A&M University.
-- The graph laplacians used in the examples are derived from the `synthetic grid repository <https://electricgrids.engr.tamu.edu/electric-grid-test-cases/>`_, made available by Dr. Adam Birchfield at Texas A&M University.
+- The graph laplacians used in the examples are derived from the `synthetic grid repository <https://electricgrids.engr.tamu.edu/electric-grid-test-cases/>`_, made available by Dr. Adam Birchfield at Texas A&M University.

{sgwt-0.3.3 → sgwt-0.3.6}/docs/conf.py

@@ -63,7 +63,7 @@ source_suffix = ".rst"
 master_doc = "index"
 
 project = "Sparse SGWT"
-copyright = "2024, Luke Lowery"
+copyright = "2025, Luke Lowery"
 author = "Luke Lowery"
 version = importlib_metadata.version("sgwt")
 release = version
@@ -73,4 +73,11 @@ html_theme_options = {
     "navigation_depth": 2,
 }
 
-autodoc_mock_imports = ["ctypes"]
+autodoc_mock_imports = ["ctypes"]
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_documents = [
+    ('index_for_pdf', 'sgwt-docs.tex', 'Sparse Graph Convolution',
+     'Luke Lowery', 'manual'),
+]