Metadata-Version: 1.1
Name: pbcluster
Version: 0.1.6
Summary: Analyze particle clusters in boxes with periodic boundaries
Home-page: https://github.com/benlindsay/pbcluster
Author: Ben Lindsay
Author-email: benjlindsay@gmail.com
License: MIT license
Description: =========
        PBCluster
        =========
        
        
        .. image:: https://img.shields.io/pypi/v/pbcluster.svg
                :target: https://pypi.python.org/pypi/pbcluster
        
        .. image:: https://img.shields.io/travis/benlindsay/pbcluster.svg
                :target: https://travis-ci.org/benlindsay/pbcluster
        
        .. image:: https://readthedocs.org/projects/pbcluster/badge/?version=latest
                :target: https://pbcluster.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://codecov.io/gh/benlindsay/pbcluster/branch/master/graph/badge.svg
                :target: https://codecov.io/gh/benlindsay/pbcluster
        
        * Free software: MIT license
        * Documentation: https://pbcluster.readthedocs.io.
        
        This packages makes it easier to analyze particle clusters in boxes with
        periodic boundaries.
        For example, take a look at this simulation box:
        
        .. image:: images/last-frame.png
                :alt: Particle cluster split across box faces
        
        All these particles belong to a single cluster, but because particles jump to
        the other side of the box when the cross one of the box faces (like in the
        classic `Asteroids game`_),
        the cluster appears split into 2 clusters plus a lone particle.
        This jumping/wrapping behavior is often called a Periodic Boundary Condition
        (PBC).
        Typical clustering packages make it difficult or impossible to account for PBCs,
        and might classify these particles as belonging to 3 separate clusters.
        PBCluster handles periodic boundary conditions, and allows you to calculate
        several particle and cluster properties.
        Here are some available properties:
        
        Cluster Properties
        ------------------
        
        - ``n_particles``: number of particles in a cluster
        - ``minimum_node_cuts``: the number of particles you'd need to remove to
          break all paths through connected particles from any face to its opposing face.
        - ``rg``: the radius of gyration of a cluster
        - ``asphericity``: a measure of the elongation of the cluster
        
        Particle Properties
        -------------------
        
        - ``coordination_number``: the number of neighboring particles connected to 
          a given particle
        
        You can install this with ``pip install pbcluster``.
        For more details check out the `Installation`_ page of the docs.
        
        For an example showing how to use PBCluster, check out the `Example`_ page of
        the docs.
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _`Asteroids game`: https://en.wikipedia.org/wiki/Asteroids_(video_game)
        .. _`Installation`: https://pbcluster.readthedocs.io/en/latest/installation.html
        .. _`Example`: https://pbcluster.readthedocs.io/en/latest/example.html
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2019-04-28)
        ------------------
        
        * First release on PyPI.
        
Keywords: pbcluster
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
