Metadata-Version: 1.1
Name: vaspy
Version: 0.8.5
Summary: A pure Python library designed to make it easy and quick to manipulate VASP files
Home-page: https://github.com/PytLab/VASPy
Author: Shao-Zheng-Jiang
Author-email: shaozhengjiang@gmail.com
License: LICENSE
Description: 
        =====
        VASPy
        =====
        
        .. image:: https://travis-ci.org/PytLab/VASPy.svg?branch=master
            :target: https://travis-ci.org/PytLab/VASPy
            :alt: Build Status
        
        .. image:: https://landscape.io/github/PytLab/VASPy/master/landscape.svg?style=flat
            :target: https://landscape.io/github/PytLab/VASPy/master
            :alt: Code Health
        
        .. image:: https://coveralls.io/repos/github/PytLab/VASPy/badge.svg?branch=master
            :target: https://coveralls.io/github/PytLab/VASPy?branch=master
        
        .. image:: https://img.shields.io/badge/python-3.5, 2.7-green.svg
            :target: https://www.python.org/downloads/release/python-351/
            :alt: platform
        
        .. image:: https://img.shields.io/badge/pypi-v0.8.5-blue.svg
            :target: https://pypi.python.org/pypi/vaspy/
            :alt: versions
        
        
        Introduction
        ------------
        
        VASPy is a pure Python library designed to make it easy and quick to manipulate VASP files.
        
        You can use VASPy to manipulate VASP files in command lins or write your own python scripts to process VASP files and visualize VASP data.
        
        In `/scripts <https://github.com/PytLab/VASPy/tree/master/scripts>`_ , there are some scripts written by me for daily use.
        
        Installation
        ------------
        1. Via pip(recommend)::
        
            pip install vaspy
        
        2. Via easy_install::
        
            easy_install vaspy
        
        3. From source::
        
            python setup.py install
        
        If you want to use **mayavi** to visualize VASP data, it is recommened to install `Canopy environment <https://store.enthought.com/downloads/#default>`_ on your device instead of installing it manually.
        
        After installing canopy, you can set corresponding aliases, for example:
        
        .. code-block:: shell
        
            alias canopy='/Users/<yourname>/Library/Enthought/Canopy/edm/envs/User/bin/python'
            alias canopy-pip='/Users/zjshao/Library/Enthought/Canopy/edm/envs/User/bin/pip'
            alias canopy-ipython='/Users/<yourname>/Library/Enthought/Canopy/edm/envs/User/bin/ipython'
            alias canopy-jupyter='/Users/<yourname>/Library/Enthought/Canopy/edm/envs/User/bin/jupyter'
        
        Then you can install VASPy to canopy::
        
            canopy-pip install vaspy
        
        
Platform: linux
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Text Processing
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
