diff --git a/README.rst b/README.rst index 2d6c59d4..bae49d81 100644 --- a/README.rst +++ b/README.rst @@ -33,13 +33,11 @@ PyGSP: Graph Signal Processing in Python The PyGSP is a Python package to ease `Signal Processing on Graphs `_. -It is a free software, distributed under the BSD license, and -available on `PyPI `_. The documentation is available on `Read the Docs `_ and development takes place on `GitHub `_. -(A `Matlab counterpart `_ exists.) +A (mostly unmaintained) `Matlab version `_ exists. The PyGSP facilitates a wide variety of operations on graphs, like computing their Fourier basis, filtering or interpolating signals, plotting graphs, @@ -60,8 +58,15 @@ main objects of the package. >>> from pygsp import graphs, filters >>> G = graphs.Logo() ->>> G.estimate_lmax() ->>> g = filters.Heat(G, tau=100) +>>> G.compute_fourier_basis() # Fourier to plot the eigenvalues. +>>> # G.estimate_lmax() is otherwise sufficient. +>>> g = filters.Heat(G, tau=50) +>>> g.plot() + +.. image:: ../pygsp/data/readme_example_filter.png + :alt: +.. image:: pygsp/data/readme_example_filter.png + :alt: 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 @@ -73,11 +78,11 @@ structure! >>> s = np.zeros(G.N) >>> s[DELTAS] = 1 >>> s = g.filter(s) ->>> G.plot_signal(s, highlight=DELTAS, backend='matplotlib') +>>> G.plot_signal(s, highlight=DELTAS) -.. image:: ../pygsp/data/readme_example.png +.. image:: ../pygsp/data/readme_example_graph.png :alt: -.. image:: pygsp/data/readme_example.png +.. image:: pygsp/data/readme_example_graph.png :alt: You can @@ -86,7 +91,7 @@ look at the `tutorials `_ to learn how to use it, or look at the `reference guide `_ -for an exhaustive documentation of the API. Enjoy the package! +for an exhaustive documentation of the API. Enjoy! Installation ------------ @@ -118,3 +123,16 @@ 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 `_. +Or cite the generic concept as:: + + @misc{pygsp, + author = {Michaël Defferrard and + Rodrigo Pena and + Alexandre Lafaye and + Basile Châtillon and + Nicolas Rod and + Lionel Martin}, + title = {PyGSP: Graph Signal Processing in Python}, + doi = {10.5281/zenodo.1003157}, + url = {https://doi.org/10.5281/zenodo.1003157}, + } diff --git a/pygsp/data/readme_example_filter.png b/pygsp/data/readme_example_filter.png new file mode 100644 index 00000000..f97605d9 Binary files /dev/null and b/pygsp/data/readme_example_filter.png differ diff --git a/pygsp/data/readme_example.png b/pygsp/data/readme_example_graph.png similarity index 100% rename from pygsp/data/readme_example.png rename to pygsp/data/readme_example_graph.png