https://github.com/odarbelaeze/vegas-lattice

Mirror of https://gitlab.com/pcmresearch/vegas-lattice
https://github.com/odarbelaeze/vegas-lattice

Last synced: 2 months ago
JSON representation

Mirror of https://gitlab.com/pcmresearch/vegas-lattice

• Host: GitHub
• URL: https://github.com/odarbelaeze/vegas-lattice
• Owner: odarbelaeze
• License: mit
• Created: 2016-01-11T14:44:34.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-25T15:24:19.000Z (almost 9 years ago)
• Last Synced: 2024-04-14T06:14:20.358Z (9 months ago)
• Language: Python
• Size: 32.2 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
.. 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.