Metadata-Version: 2.1
Name: helixvis
Version: 1.0.0
Summary: Create 2-dimensional visualizations of alpha-helical peptide sequences
Home-page: https://pypi.org/project/helixvis/
Author: Vigneshwar Subramanian, Raoul Wadhwa, Regina Stevens-Truss
Maintainer-email: vxs294@case.edu
License: GPL-3
Project-URL: Bug Tracker, https://github.com/subramv1/helixvis/issues
Project-URL: Documentation, https://github.com/subramv1/helixvis/blob/master/DOCUMENTATION.md
Project-URL: Source Code, https://github.com/subramv1/helixvis
Description: # helixvis: Visualize alpha-helical peptide sequences in Python
        
        ## Purpose
        
        Built by the lab of Regina Stevens-Truss, PhD (Professor & Chair, Department of Chemistry, Kalamazoo College), helixvis can be used to create publication-quality, 2-dimensional visualizations of alpha-helical peptide sequences.
        Specifically, this package allows the user to programmatically generate helical wheels and wenxiang diagrams to provide a bird's eye, top-down view of alpha-helical oligopeptides.
        Although other tools exist to complete this task, they generally provide a graphical user interface for manual input of peptide sequences, without allowing for programmatic creation and customization of visualizations.
        Programmatic generation of helical wheels in open source Python provides multiple benefits, including:
        
        * quick and easy incorporation of wheels into markdown documents
        * rapid visualization of many peptides (e.g. all the elements of a peptide database) without manual steps
        * programmatic customization of visualizations
        * reproducibility: practically zero manual steps required for design and creation of helical wheels and wenxiang diagrams
        
        This is a port of R package `helixvis` into Python. See https://doi.org/10.21105/joss.01008 for more details.
        
        ## Installation
        
        The source code is currently hosted on GitHub at: https://github.com/subramv1/helixvis
        
        helixvis can be found on the Python package index at: https://pypi.org/project/helixvis/
        
        The most up-to-date release can be installed as follows:
        
        ```python
        python -m pip install -U pip
        python -m pip install -U helixvis
        
        ```
        
        ## Dependencies
        
        * NumPy
        * Pandas
        * Matplotlib
        
        ## Usage
        
        ```python   
        # load helixvis
        import helixvis
        
        # make helical wheel for "ADEKLGSRTW"
        helixvis.draw_wheel("ADEKLGSRTW")
        
        # make wenxiang diagram for "ADEKLGSRTW"
        helixvis.draw_wenxiang("ADEKLGSRTW")
        ```
        
        ## License
        
        GPL-3
        
        ## Contributions
        
        
        Please report any bugs, suggestions, etc. on the [issues page](https://github.com/subramv1/helixvis/issues) of the [helixvis GitHub repository](https://github.com/subramv1/helixvis).
        Contributions (bug fixes, new features, etc.) are welcome via pull requests (generally from forked repositories).
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Chemistry
Description-Content-Type: text/markdown
