Metadata-Version: 2.1
Name: diffupy
Version: 0.0.2
Summary: Compute diffusion scores over networks
Home-page: https://github.com/multipaths/DiffuPy
Author: Josep Marín-Llaó, Sergi Picart Armada, Daniel Domingo-Fernández
Author-email: josepmarinllao@gmail.com
Maintainer: Josep Marín-Llaó
Maintainer-email: josepmarinllao@gmail.com
License: Apache 2.0 License
Download-URL: https://github.com/multipaths/DiffuPy
Project-URL: Bug Tracker, https://github.com/multipaths/DiffuPy/issues
Project-URL: Source Code, https://github.com/multipaths/DiffuPy
Project-URL: Documentation, https://diffupy.readthedocs.io
Description: DiffuPy |build| |docs|
        ======================
        
        DiffuPy is a generalizable Python implementation of the numerous label propagation algorithms `(see all here)
        <https://diffupy.readthedocs.io/en/latest/diffusion.html#summary-tables>`_.
        
        Installation
        ------------
        1. ``diffupy`` can be installed with the following commands:
        
        .. code-block:: sh
        
            $ python3 -m pip install git+https://github.com/multipaths/DiffuPy.git@master
        
        2. or in editable mode with:
        
        .. code-block:: sh
        
            $ git clone https://github.com/multipaths/DiffuPy.git
            $ cd diffupy
            $ python3 -m pip install -e .
        
        Command Line Interface
        ----------------------
        The following commands can be used directly use from your terminal:
        
        1. **Run a diffusion analysis**
        The following command will run a diffusion method on a given network with the given data.  More information `here
        <https://diffupy.readthedocs.io/en/latest/diffusion.html>`_.
        
        .. code-block:: sh
        
            $ python3 -m diffupy diffuse --network=<path-to-network-file> --input=<path-to-data-file> --method=<method>
        
        
        2. **Generate a kernel with one of the seven methods implemented**
        Generates the regularised Laplian kernel of a given graph. More information in the `documentation
        <https://diffupy.readthedocs.io/en/latest/kernels.html>`_.
        
        .. code-block:: sh
        
            $ python3 -m diffupy kernel --network=<path-to-network-file>
        
        Disclaimer
        ----------
        DiffuPy is a scientific software that has been developed in an academic capacity, and thus comes with no warranty or
        guarantee of maintenance, support, or back-up of data.
        
        .. |build| image:: https://travis-ci.com/multipaths/diffupy.svg?branch=master
            :target: https://travis-ci.com/multipaths/diffupy
            :alt: Build Status
        
        .. |docs| image:: http://readthedocs.org/projects/diffupy/badge/?version=latest
            :target: https://diffupy.readthedocs.io/en/latest/
            :alt: Documentation Status
        
        .. |coverage| image:: https://codecov.io/gh/multipaths/diffupy/coverage.svg?branch=master
            :target: https://codecov.io/gh/multipaths/diffupy?branch=master
            :alt: Coverage Status
        
Keywords: Heat Diffusion,Systems Biology,Networks Biology
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.5
Provides-Extra: docs
