Metadata-Version: 2.1
Name: graphtools
Version: 0.2.1
Summary: graphtools
Home-page: https://github.com/KrishnaswamyLab/graphtools
Author: Jay Stanley and Scott Gigante, Krishnaswamy Lab, Yale University
Author-email: jay.stanley@yale.edu
License: GNU General Public License Version 2
Download-URL: https://github.com/KrishnaswamyLab/graphtools/archive/v0.2.1.tar.gz
Keywords: graphs,big-data,signal processing,manifold-learning
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering :: Mathematics
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: numpy (>=1.14.0)
Requires-Dist: scipy (>=1.1.0)
Requires-Dist: pygsp (>=0.5.1)
Requires-Dist: scikit-learn (>=0.20.0)
Requires-Dist: future
Requires-Dist: tasklogger (>=0.4.0)
Provides-Extra: doc
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinxcontrib-napoleon; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex; extra == 'doc'
Provides-Extra: test
Requires-Dist: nose2; extra == 'test'
Requires-Dist: pandas; extra == 'test'
Requires-Dist: coverage; extra == 'test'
Requires-Dist: coveralls; extra == 'test'
Requires-Dist: python-igraph; extra == 'test'
Requires-Dist: anndata; extra == 'test'

==========
graphtools
==========

.. image:: https://img.shields.io/pypi/v/graphtools.svg
    :target: https://pypi.org/project/graphtools/
    :alt: Latest PyPi version
.. image:: https://anaconda.org/conda-forge/graphtools/badges/version.svg
    :target: https://anaconda.org/conda-forge/graphtools/
    :alt: Latest Conda version
.. image:: https://api.travis-ci.com/KrishnaswamyLab/graphtools.svg?branch=master
    :target: https://travis-ci.com/KrishnaswamyLab/graphtools
    :alt: Travis CI Build
.. image:: https://img.shields.io/readthedocs/graphtools.svg
    :target: https://graphtools.readthedocs.io/
    :alt: Read the Docs
.. image:: https://coveralls.io/repos/github/KrishnaswamyLab/graphtools/badge.svg?branch=master
    :target: https://coveralls.io/github/KrishnaswamyLab/graphtools?branch=master
    :alt: Coverage Status
.. image:: https://img.shields.io/twitter/follow/KrishnaswamyLab.svg?style=social&label=Follow
    :target: https://twitter.com/KrishnaswamyLab
    :alt: Twitter
.. image:: https://img.shields.io/github/stars/KrishnaswamyLab/graphtools.svg?style=social&label=Stars
    :target: https://github.com/KrishnaswamyLab/graphtools/
    :alt: GitHub stars

Tools for building and manipulating graphs in Python.

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

graphtools is available on `pip`. Install by running the following in a terminal::

    pip install --user graphtools

Alternatively, graphtools can be installed using `Conda <https://conda.io/docs/>`_ (most easily obtained via the `Miniconda Python distribution <https://conda.io/miniconda.html>`_)::

    conda install -c conda-forge graphtools

Or, to install the latest version from github::

    pip install --user git+git://github.com/KrishnaswamyLab/graphtools.git

Usage example
-------------

The `graphtools.Graph` class provides an all-in-one interface for k-nearest neighbors, mutual nearest neighbors, exact (pairwise distances) and landmark graphs.

Use it as follows::

    from sklearn import datasets
    import graphtools
    digits = datasets.load_digits()
    G = graphtools.Graph(digits['data'])
    K = G.kernel
    P = G.diff_op
    G = graphtools.Graph(digits['data'], n_landmark=300)
    L = G.landmark_op

Help
----

If you have any questions or require assistance using graphtools, please contact us at https://krishnaswamylab.org/get-help


