Metadata-Version: 2.0
Name: PyGSP
Version: 0.5.1
Summary: Graph Signal Processing in Python
Home-page: https://github.com/epfl-lts2/pygsp
Author: EPFL LTS2
Author-email: UNKNOWN
License: BSD
Description-Content-Type: UNKNOWN
Keywords: graph signal processing
Platform: any
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Environment :: Console
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: alldeps
Requires-Dist: scikit-image; extra == 'alldeps'
Requires-Dist: pyunlocbox; extra == 'alldeps'
Requires-Dist: matplotlib; extra == 'alldeps'
Requires-Dist: pyqtgraph; extra == 'alldeps'
Requires-Dist: PyOpenGL; extra == 'alldeps'
Provides-Extra: alldeps
Requires-Dist: PySide; python_version < "3.5" and extra == 'alldeps'
Provides-Extra: alldeps
Requires-Dist: pyflann; python_version == "2.*" and extra == 'alldeps'
Provides-Extra: alldeps
Requires-Dist: pyflann3; python_version == "3.*" and extra == 'alldeps'
Provides-Extra: alldeps
Requires-Dist: PyQt5; python_version >= "3.5" and extra == 'alldeps'
Provides-Extra: doc
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: numpydoc; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex; extra == 'doc'
Requires-Dist: sphinx-rtd-theme; extra == 'doc'
Provides-Extra: pkg
Requires-Dist: wheel; extra == 'pkg'
Requires-Dist: twine; extra == 'pkg'
Provides-Extra: test
Requires-Dist: flake8; extra == 'test'
Requires-Dist: coverage; extra == 'test'
Requires-Dist: coveralls; extra == 'test'

========================================
PyGSP: Graph Signal Processing in Python
========================================

+--------------------------------------------------+
| |doc|  |pypi|  |zenodo|  |license|  |pyversions| |
+--------------------------------------------------+
| |binder|  |travis|  |coveralls|  |github|        |
+--------------------------------------------------+

.. |doc| image:: https://readthedocs.org/projects/pygsp/badge/?version=latest
   :target: https://pygsp.readthedocs.io
.. |pypi| image:: https://img.shields.io/pypi/v/pygsp.svg
   :target: https://pypi.python.org/pypi/PyGSP
.. |zenodo| image:: https://zenodo.org/badge/16276560.svg
   :target: https://doi.org/10.5281/zenodo.1003157
.. |license| image:: https://img.shields.io/pypi/l/pygsp.svg
   :target: https://github.com/epfl-lts2/pygsp/blob/master/LICENSE.txt
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/pygsp.svg
   :target: https://pypi.python.org/pypi/PyGSP
.. |travis| image:: https://img.shields.io/travis/epfl-lts2/pygsp.svg
   :target: https://travis-ci.org/epfl-lts2/pygsp
.. |coveralls| image:: https://img.shields.io/coveralls/epfl-lts2/pygsp.svg
   :target: https://coveralls.io/github/epfl-lts2/pygsp
.. |github| image:: https://img.shields.io/github/stars/epfl-lts2/pygsp.svg?style=social
   :target: https://github.com/epfl-lts2/pygsp
.. |binder| image:: https://mybinder.org/badge.svg
   :target: https://mybinder.org/v2/gh/epfl-lts2/pygsp/master?filepath=playground.ipynb

The PyGSP is a Python package to ease
`Signal Processing on Graphs <https://arxiv.org/abs/1211.0053>`_.
It is a free software, distributed under the BSD license, and
available on `PyPI <https://pypi.python.org/pypi/PyGSP>`_.
The documentation is available on
`Read the Docs <https://pygsp.readthedocs.io>`_
and development takes place on
`GitHub <https://github.com/epfl-lts2/pygsp>`_.
(A `Matlab counterpart <https://lts2.epfl.ch/gsp>`_ exists.)

The PyGSP facilitates a wide variety of operations on graphs, like computing
their Fourier basis, filtering or interpolating signals, plotting graphs,
signals, and filters. Its core is spectral graph theory, and many of the
provided operations scale to very large graphs. The package includes a wide
range of graphs, from point clouds like the Stanford bunny and the Swiss roll;
to networks like the Minnesota road network; to models for generating random
graphs like stochastic block models, sensor networks, Erdős–Rényi model,
Barabási-Albert model; to simple graphs like the path, the ring, and the grid.
Many filter banks are also provided, e.g. various wavelets like the Mexican
hat, Meyer, Half Cosine; some low-pass filters like the heat kernel and the
exponential window; and Gabor filters. Despite all the pre-defined models, you
can easily use a custom graph by defining its adjacency matrix, and a custom
filter bank by defining a set of functions in the spectral domain.

The following demonstrates how to instantiate a graph and a filter, the two
main objects of the package.

>>> from pygsp import graphs, filters
>>> G = graphs.Logo()
>>> G.estimate_lmax()
>>> g = filters.Heat(G, tau=100)

Let's now create a graph signal: a set of three Kronecker deltas for that
example. We can now look at one step of heat diffusion by filtering the deltas
with the above defined filter. Note how the diffusion follows the local
structure!

>>> import numpy as np
>>> DELTAS = [20, 30, 1090]
>>> s = np.zeros(G.N)
>>> s[DELTAS] = 1
>>> s = g.filter(s)
>>> G.plot_signal(s, highlight=DELTAS, backend='matplotlib')

.. image:: ../pygsp/data/readme_example.png
    :alt:
.. image:: pygsp/data/readme_example.png
    :alt:

You can
`try it online <https://mybinder.org/v2/gh/epfl-lts2/pygsp/master?filepath=playground.ipynb>`_,
look at the
`tutorials <https://pygsp.readthedocs.io/en/stable/tutorials/index.html>`_
to learn how to use it, or look at the
`reference guide <https://pygsp.readthedocs.io/en/stable/reference/index.html>`_
for an exhaustive documentation of the API. Enjoy the package!

Installation
------------

The PyGSP is available on PyPI::

    $ pip install pygsp

Note that you will need a recent version of ``pip`` and ``setuptools``. Please
run ``pip install --upgrade pip setuptools`` if you get any installation error.

Contributing
------------

See the guidelines for contributing in ``CONTRIBUTING.rst``.

Acknowledgments
---------------

The PyGSP was started in 2014 as an academic open-source project for
research purpose at the `EPFL LTS2 laboratory <https://lts2.epfl.ch>`_.
This project has been partly funded by the Swiss National Science Foundation
under grant 200021_154350 "Towards Signal Processing on Graphs".

If you are using the library for your research, for the sake of
reproducibility, please cite the version you used as indexed by
`Zenodo <https://doi.org/10.5281/zenodo.1003157>`_.


