Metadata-Version: 1.1
Name: pbxplore
Version: 1.3.2
Summary: PBxplore is a suite of tools dedicated to Protein Block analysis.
Home-page: https://github.com/pierrepo/PBxplore
Author: Pierre Poulain
Author-email: pierre.poulain@cupnet.net
License: MIT
Description: PBxplore
        ========
        
        .. image:: https://travis-ci.org/pierrepo/PBxplore.svg?branch=master
            :alt: Travis CI build status
            :target: https://travis-ci.org/pierrepo/PBxplore
        
        .. image:: https://img.shields.io/pypi/pyversions/pbxplore.svg
            :alt: PyPI Python version
        
        .. image:: https://badge.fury.io/py/pbxplore.svg
            :alt: PyPI PBxplore version
            :target: https://pypi.python.org/pypi/pbxplore
        
        
        **PBxplore** is a suite of tools dedicated to Protein Block (PB) analysis.
        Protein Blocks are structural prototypes defined by
        `de Brevern et al <https://www.ncbi.nlm.nih.gov/pubmed/11025540>`_. The 3-dimensional local
        structure of a protein backbone can be modelized as an 1-dimensional sequence of PBs.
        In principle, any conformation of any amino acid could be represented by one of
        the sixteen available Protein Blocks (see Figure 1).
        
        .. image:: https://raw.githubusercontent.com/pierrepo/PBxplore/master/doc/source/img/PBs.jpg
            :alt: PBs
        
        **Figure 1.** Schematic representation of the sixteen protein blocks,
        labeled from *a* to *p* (`Creative commons 4.0 CC-BY <https://creativecommons.org/licenses/by/4.0/>`_).
        
        
        PBxplore provides both a Python library and command-line tools. Basically, PBxplore can:
        
        * **assign PBs** from either a PDB or either a molecular dynamics trajectory.
        * use analysis tools to perform **statistical analysis** on PBs.
        * use analysis tools to **study protein flexibility and deformability**.
        
        For details, see the documentation at https://pbxplore.readthedocs.org/en/latest/.
        
        Requirements
        ------------
        
        PBxplore requires:
        
        * Python 2.7 or Python 3.x (>= 3.3)
        * the `NumPy <http://numpy.scipy.org/>`_ Python library,
        
        Optionally, PBxplore can use:
        
        * the `MDAnalysis <https://code.google.com/p/mdanalysis/>`_ Python library (version >= 0.11) to read MD trajectories generated by Gromacs (.xtc files),
        * the `Matplotlib <http://matplotlib.org/>`_ Python library to generate plots.
        * `WebLogo 3 <http://weblogo.threeplusone.com/>`_ to create logo from PB sequences.
        
        
        Installation
        ------------
        
        Once dependencies installed, the most straightforward way is to use `pip`:
        
        .. code-block:: bash
        
            $ pip install pbxplore
        
        
        PBxplore can also be installed for the current user only:
        
        .. code-block:: bash
        
            $ pip install --user pbxplore
        
        
        Documentation
        -------------
        
        All documentation are hosted by Read The Docs and can be found `here <https://pbxplore.readthedocs.org/en/latest/>`_.
        
        Contact & Support
        -----------------
        
        PBxplore is a research software and has been developped by:
        
        * Pierre Poulain, DSIMB, Ets Poulain, Pointe-Noire, Congo
        * Jonathan Barnoud, University of Groningen, Groningen, The Netherlands
        * Hubert Santuz, DSIMB, Paris, France
        * Alexandre G. de Brevern, DSIMB, Paris, France
        
        If you want to report a bug, request a feature,
        use the `GitHub issue system <https://github.com/pierrepo/PBxplore/issues>`_.
        
        
        License
        -------
        
        PBxplore is licensed under `The MIT License <https://github.com/pierrepo/PBxplore/blob/master/LICENSE>`_.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
