Metadata-Version: 1.1
Name: vegas-lattice
Version: 0.4.0
Summary: A grid lattice sample generator
Home-page: https://github.com/odarbelaeze/vegas-lattice
Author: Oscar D. Arbeláez <@odarbelaeze>, Juan D. Alzate <@jdalzatec>
Author-email: odarbelaeze@gmail.com
License: MIT license
Download-URL: https://github.com/odarbelaeze/vegas-lattice/tarball/0.4.0
Description: .. image:: https://travis-ci.org/odarbelaeze/vegas-lattice.svg?branch=master
            :target: https://travis-ci.org/odarbelaeze/vegas-lattice
        
        =============
        vegas-lattice
        =============
        
        A lattice generator part of the **vegas** software initiative, it provides the
        esential routines to generate regular graph lattices in linear time, as well as
        some cuts of those lattices for nano particles and randomly depleted lattices.
        
        Instalation
        -----------
        
        The **vegas-lattice** program has been tested in python 3.4 and 3.5 to work
        properly, you can install the package from the python package index using the
        following command:
        
        .. code-block:: bash
        
            pip install vegas-lattice   # this might require sudo
        
        After that the `vegas-lattice` command should be available to your command
        prompt.
        
        Feel free to use the descriptor files provided in the **docs** directory to do
        some tests, and also to run
        
        .. code-block:: bash
        
            vegas-lattice --help
        
        to get some instructions in how to use the program.
        
        Features
        --------
        
        The **vegas-lattice** package currently features three main routines:
        
        - **bulk** creates a cubic lattice with the specified periodic boundary
          conditions.
        - **nanoparticle** creates a spherical nanoparticle of the given diameter.
        - **depleted** creates a bulk lattice with random site depletion.
        - **describe** bootstraps a descriptor file using a simple site list.
        
        
Keywords: lattice,graph,magnetite,construction,grid
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Physics
