Metadata-Version: 2.1
Name: nezzle
Version: 0.0.3
Summary: Nezzle: a programmable and interactive network visualization software
Home-page: https://github.com/dwgoon/nezzle
Author: Daewon Lee
Author-email: daewon4you@gmail.com
License: MIT
Description: 
        
        ## Introduction 
        - Nezzle is an interactive and programmable visualization software for small-scale networks (N < 100).
        - Nezzle was initially developed to visualize biological networks such as 
          [signaling networks](https://www.nature.com/articles/s41598-018-23643-5).
        - Nezzle repesents **Ne**t + Pu**zzle**, because adjusting nodes and edges of a network for visualization is similar to doing a puzzle.
        - Nezzle is currently under active development.
        - Consider ["Cytoscape"](https://cytoscape.org/) or ["Gephi"](https://gephi.org/) for large-scale networks.
         
        ## Features
        - Lightweight, programmable, detailed visualization of small-scale networks for high quality figures.
        - Highly customizable visualization of networks with user-defined source codes.
        - Manual curation of the positions of nodes and edges by adjusting the graphics in GUI.
        - Interactive programming to modify both data and graphics of networks in the GUI console.
        - The GUI depends on Python bindings for [`Qt`](https://www.qt.io/)
          such as [`PyQt`](https://riverbankcomputing.com/software/pyqt)
          (abstracted by [`QtPy`](https://github.com/spyder-ide/qtpy) in this project).
        
        
        ## Installation
        
        [Anaconda](https://www.anaconda.com) is recommended to use and develop Nezzle.
        
        
        ### Anaconda virtual environment
        
        After installing anaconda, create a conda virtual environment for Nezzle.
        
        ```
        conda create -n nezzle
        ```
        
        Now, we can activate our virtual environment for Nezzle as follows.
        
        ```
        conda activate nezzle
        ```
        
        Install `pip` for installing the dependencies.
        
        ```
        conda install pip
        ```
        
        ### Dependency
        Check packages and versions in 
        [requirements](https://github.com/dwgoon/nezzle/blob/main/requirements.txt) or
        [requirements for conda](https://github.com/dwgoon/nezzle/blob/main/requirements_conda.txt). 
        
        We can install all the dependencies using `pip` with `-r` option.
        
        ```
        pip install -r requirements.txt
        ```
        
        We can also install the dependencies using conda with `--file` option.
        
        ```
        conda install -y --file requirements_conda.txt
        ```
        
        ### Install from PyPI
        The simplest way to install Nezzle is using `pip`.
        
        ```
        pip install nezzle
        ```
        
        However, the installed package with `pip` do not contain the examples.
        To explore the examples, install from this GitHub repository.
        
        
        ### Install from GitHub repository
        First, clone the recent version of this repository.
        
        ```
        git clone https://github.com/dwgoon/nezzle.git nezzle
        ```
        
        Now, we need to install Nezzle as a module.
        
        ```
        cd nezzle
        pip install -r requirements.txt
        python setup.py install
        ```
        
        ## Execution
        In a terminal, we can just type "nezzle" that is in the "Scripts" sub-directory of a Python environment.
        
        ```
        nezzle
        ```
        
        Alternatively, we can execute the program in the local repository as follows. 
        
        ```
        python nezzle.py
        ```
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
