Metadata-Version: 1.1
Name: GBpy
Version: 0.1.1
Summary: GBpy is an opensource python package for calculating the geometric properties of interfaces in crystals.
Home-page: https://github.com/adehgha/GBpy
Author: Arash Dehghan Banadaki, Srikanth Patala
Author-email: adehgha@ncsu.edu, spatala@ncsu.edu
License: License :: GNU-GPL
Download-URL: https://github.com/adehgha/GBpy/tarball/0.1.1
Description:                 GBpy:
                        =====
                        
                        GBpy is a python package for finding the geometrical properties of a Bicrystal. It includes all the necessary tools for constructing a simulation box for grain boundary simulation.
                        
                        .. image:: https://raw.githubusercontent.com/adehgha/GBpy/master/GBpy/docs/images/pic.png
                
                        * GBpy on `GitHub <https://github.com/adehgha/GBpy>`__
                        * The GBpy `manual <https://github.com/adehgha/GBpy>`__
                
                        Functions:
                        ==========
                
                        * ``GBpy.bp_basis``, collection of functions for calculating the basis vectors of a single or bicrystal (general lattices).
                        * ``GBpy.find_csl_dsc``, collection of functions for finding the CSL and DSC lattices of a bicrystal (general lattices).
                        * ``GBpy.generate_symm_ops``, a function for constructing various group symmetry operations.
                        * ``GBpy.quaternion``, collection of functions for quaternion operations.
                        * ``GBpy.misorient_fz``, function for finding the unique disorientations in fundamental zone of various crystal point groups.
                        * ``GBpy.integer_manipulations``, collection of many useful ineteger manipulation functions.
                        
                        and many other useful tools. Please refer to the documentation and example for detailed description and utility of functions.
                        
                        Classes:
                        ========
                        
                        - ``lattice``: Includes all the crystallographic data required for an element used by the code.
                        - ``quaternion``: Quaternion construction and operations.
                
                
                        How to Use This Package:
                        ========================
                        1. To install the stable version of GBpy:
                        
                        .. code-block:: console
                        
                            $ pip install GBpy
                                               
                        
                        * To install the development version of GBpy Clone the repository:
                        
                        .. code-block:: console
                        
                            $ git clone https://github.com/adehgha/GBpy.git
                        
                        and run the setup script.
                        	
                        .. code-block:: console
                        
                            $ python setup.py install
                           
                        2. Import the package: 
                        
                        .. code-block:: pycon
                        
                            >>> import GBpy
                                  
                        3. Call the function by using:
                        
                        .. code-block:: pycon
                        
                            >>> GBpy.<name_of_the_function>
                        	
                        for example to find the 2D basis vectors of a plane with Miller indices of (h,k,l):
                        
                        .. code-block:: pycon
                        
                            >>> GBpy.bp_basis.bp_basis([h,k,l])
                        
                        4. You can also use the tools provided in this package individually by importing the functions separately. For example use :``from GBpy import <name_of_the_function> as <a_name>``.
                        
                        Consult the documentation for further details.
                
                
                        Prerequisites:
                        ==============
                        
                        1. install ``numpy`` from `here. <http://www.numpy.org/>`__
                        
                        2. install ``scipy`` from `here. <http://www.scipy.org/>`__
                        
                        3. install ``setuptools`` from `here. <https://pypi.python.org/pypi/setuptools>`__
                        
                        
                        Credits:
                        ========
                        GBpy is written by:
                        
                        * `Srikanth Patala <spatala@ncsu.edu>`__
                        * `Arash Dehghan Banadaki <adehgha@ncsu.edu>`__
                        * `web address <http://patala.org/>`__.
                
                        Copyright (c) 2014,  Arash Dehghan Banadaki and Srikanth Patala.
        
Keywords: bicrystallography,interfaces,grain boundaries
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.0
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires: numpy
Requires: scipy
Requires: setuptools
