Metadata-Version: 2.1
Name: storystructure
Version: 1.0.2
Summary: Tools for analysing the structure of branching stories
Home-page: https://github.com/sellisd/storystructure
Author: Diamantis Sellis
Author-email: sellisd@gmail.com
License: UNKNOWN
Description: storystructure
        ==============
        
        A Python package to explore the structure of branching stories.
        `Documentation <https://sellisd.github.io/storystructure/>`
        
        Requirements
        ------------
        
        The module has been developed with python 3.6.6 and the following modules. Other
        versions might work also but have not been tested:
        
        * ``pathlib2 v.2.2.0``
        * ``pandas v.0.19.2``
        * ``numpy v.1.11.3``
        
        Installation
        ------------
        
        .. code-block::  bash
        
            pip install storystructure
        
        Example usage
        -------------
        
        To use the package two input data files are necessary:
        
        * An *edgelist* file with columns ``source`` and ``target``
        * A *node attributes* file with columns ``node`` and ``attribute``. The attribute column must be on of the following values ``good``, ``bad``, ``pause``.
        
        .. code-block:: python
        
            from storystructure.storystructure import storystructure
            # create a new object
            s = storystructure.storystructure()
            # load an edgelist and node attributes
            s.loadStory(edges='edgelist.csv',
                        nodes='nodeAttributes.csv')
            s.saveFig('graph'.png')     # Make figure
            s.simplify() # Removing self loops and double edges
            s.makeGraph()
            s.savePathStats('allPaths.dat')
        
        An more detailed example is included in the jupyter notebook ``scripts/Tutorial.ipybn``
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/x-rst
