Metadata-Version: 1.1
Name: hetio
Version: 0.2.6
Summary: Hetnets in Python
Home-page: https://github.com/dhimmel/hetio
Author: Daniel Himmelstein
Author-email: daniel.himmelstein@gmail.com
License: CC0 1.0
Description: Hetnets in Python
        =================
        
        |Latest DOI| |GitHub issues| |Build Status|
        
        Background
        ----------
        
        **Hetnets**: Hetnets, also
        `called <https://doi.org/10.15363/thinklab.d104>`__ *heterogeneous
        information networks*, are graphs with multiple node and edge types.
        Hetnets are both multipartite and multirelational. They provide a
        scalable, intuitive, and frictionless structure for data integration.
        
        **Purpose**: This package provides data structures for hetnets and
        algorithms for `edge prediction <http://het.io/hnep/>`__. It only
        supports hetnets, which is its primary advantage compared to other
        network software. Node/edge attributes and edge directionality are
        supported.
        
        **Impetus**: Development originated with a
        `study <https://doi.org/10.1371/journal.pcbi.1004259>`__ to predict
        disease-associated genes and continues with a successive
        `study <https://doi.org/10.15363/thinklab.4>`__ to repurpose drugs.
        
        **Caution**: Documentation is currently lacking, testing coverage is
        poor, and the API is unstable. Contributions are welcome. Please use
        `GitHub Issues <https://github.com/dhimmel/hetio/issues>`__ for
        feedback, questions, or troubleshooting.
        
        Installation
        ------------
        
        |PyPI|
        
        Please use Python 3.4 or higher. To install the current PyPI version
        (recommended), run:
        
        .. code:: sh
        
            pip install hetio
        
        For the latest GitHub version, run:
        
        .. code:: sh
        
            pip install git+https://github.com/dhimmel/hetio.git#egg=hetio
        
        For development, clone or download-and-extract the repository. Then run
        ``pip install -e .`` from the repository's root directory. The ``-e``
        flag specifies
        `editable <https://pythonhosted.org/setuptools/setuptools.html#development-mode>`__
        mode, so updating the source updates your installation.
        
        Once installed, tests can be executed by running ``py.test test/`` from
        the repository's root directory.
        
        Design
        ------
        
        A Graph object stores a heterogeneous network and relies on the
        following classes:
        
        1. Graph
        2. MetaGraph
        3. Edge
        4. MetaEdge
        
        Release instructions
        --------------------
        
        This section is only relevant for project maintainers. Travis CI
        deployments are used to upload releases to
        `PyPI <https://pypi.org/project/hetio>`__ and `GitHub
        releases <https://github.com/dhimmel/hetio/releases>`__. To create a new
        release, do the following:
        
        1. Bump the version in ```__init__.py`` <hetio/__init__.py>`__.
        
        2. Add a release notes file in ```release-notes`` <release-notes>`__.
           Format as a commit message that will be used as the GitHub release
           description.
        
        3. Run the following commands:
        
        ``sh   TAG=v`python setup.py --version`   git add hetio/__init__.py release-notes/$TAG.*   git commit --message "Upgrade to $TAG"   git push   git tag --annotate $TAG --file release-notes/$TAG.*   git push --tags``
        
        4. Recommended: Edit the GitHub release to improve formating and add a
           Zenodo badge.
        
        .. |Latest DOI| image:: https://zenodo.org/badge/14475/dhimmel/hetio.svg
           :target: https://zenodo.org/badge/latestdoi/14475/dhimmel/hetio
        .. |GitHub issues| image:: https://img.shields.io/github/issues/dhimmel/hetio.svg
           :target: https://github.com/dhimmel/hetio/issues
        .. |Build Status| image:: https://travis-ci.org/dhimmel/hetio.svg?branch=master
           :target: https://travis-ci.org/dhimmel/hetio
        .. |PyPI| image:: https://img.shields.io/pypi/v/hetio.svg
           :target: https://pypi.python.org/pypi/hetio
        
Keywords: hetnet graph heterogeneous network neo4j hetio
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
