Metadata-Version: 1.1
Name: netwulf
Version: 0.0.6
Summary: Interactively visualize networks with Ulf Aslak's d3-tool from Python.
Home-page: https://github.com/benmaier/netwulf
Author: Ulf Aslak, Benjamin F. Maier
Author-email: bfmaier@physik.hu-berlin.de
License: MIT
Description: .. figure:: https://github.com/benmaier/netwulf/raw/master/img/logo_small.png
           :alt: logo
        
           logo
        
        netwulf
        =======
        
        This package provides an interface between
        `networkx <https://networkx.github.io/>`__ Graph objects and `Ulf
        Aslak's interactive web
        app <https://github.com/ulfaslak/network_styling_with_d3>`__ for simple
        and better network visualizations.
        
        Install
        -------
        
        ::
        
            pip install netwulf
        
        Beware: ``netwulf`` only works with Python 3!
        
        Example
        -------
        
        Standard
        ~~~~~~~~
        
        Create a network and look at it
        
        .. code:: python
        
            import networkx as nx
            from netwulf import visualize
        
            G = nx.barabasi_albert_graph(100,m=1)
            visualize(G)
        
        .. figure:: https://github.com/benmaier/netwulf/raw/master/img/BA_1.png
           :alt: visualization example
        
           visualization example
        
        Config
        ~~~~~~
        
        It's possible to change the default settings which are
        
        .. code:: python
        
            default_config = {
              'Apply heat (wiggle)': False,
              'Charge strength': -10,
              'Center gravity': 0.1,
              'Link distance': 10,
              'Link width': 2,
              'Link alpha': 0.5,
              'Node size': 10, 
              'Node stroke size': 0.5,
              'Node size exponent': 0.5,
              'Link strength exponent': 0.1,
              'Link width exponent': 0.5,
              'Collision': False,
              'Node fill': '#16a085',
              'Node stroke': '#000000',
              'Link stroke': '#7c7c7c',
              'Label stroke': '#000000',
              'Show labels': False,
              'Zoom': 1.5,
              'Min. link weight %': 0,
              'Max. link weight %': 100
            }
        
        It's done like so:
        
        .. code:: python
        
            import networkx as nx
            from netwulf import visualize
        
            G = nx.barabasi_albert_graph(5000,m=1)
            visualize(G,config={
                    'Node size': 11,
                    'Charge strength' : -0.8,
                    'Link distance' : 10,
                    'Link width' : 1,
                    'Collision' : True,
                })
        
        .. figure:: https://github.com/benmaier/netwulf/raw/master/img/BA_2.png
           :alt: visualization example
        
           visualization example
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
