Skip to main content

Package for handling io of vasp package in kumagai group at Tokyo Institute of Technology

Project description

PyPI - License PyPI - Python Version CircleCI

vise

Vasp Integrated Simulation Environment (vise) is a collection of tools that supports VASP users to prepare input files for the VASP calculations, handle its calculation errors, and analyze its results.

Note1: Only ensure VASP ver5.4.4 so far. Note2: Units used in pydefect are eV for energy and angstrom for length following the vasp convention. Note3: When transforming the structure to the primitive one, antiferromagnetic magnetization is not supported.

Installation instructions

  1. Requirements
  • Python 3.6 or higher
  • pymatgen
  • spglib
  • seekpath
  • see requirements.txt for others
  1. Latest stable version is released at PyPI repository, so one can download it using pip install vise.

Executing this software

  1. Command line method
  • execute vise -h for detailed description of available options
  1. Usage as a module
  • vise can be imported as a python module

More information in the online manual at: https://kumagai-group.github.io/vise/

Files and directories included in vise distribution

  README                    : introduction
  LICENSE                   : the MIT license 
  setup.py                  : installation script
  requirements.txt          : list of required packages

  /vise/analyzer            : tools for VASP analysis especially for band figure and density of states
  /vise/chempotdiag         : tools for drawing the chemical potential diagram
  /vise/cli                 : command line interfaces
  /vise/custodian_extension : original custodian exention
  /vise/input_set           : tools for generating VASP input files
  /vise/test_files          : test files used mainly for unitests
  /vise/util                : useful tools 

License

Python code is licensed under the MIT License.

Development notes

Bugs, requests and questions

Please use the Issue Tracker to report bugs, request features.

Code contributions

We are always welcome people who want to make vise better. Please use the "Fork and Pull" workflow to make contributions and stick as closely as possible to the following:

  • Code style follows PEP8 and Google's writing style.
  • Add unittests wherever possible including scripts for command line interfaces.

Tests

Run the tests using pytest vise. We also use integrated testing on Github via circleCI.

Citing vise

If vise has been used in your research, please consider citing our Github repo!

Contact info

Yu Kumagai
yuuukuma@gmail.co.jp

Tokyo Institute of Technology (Japan)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for vise, version 0.1.13
Filename, size File type Python version Upload date Hashes
Filename, size vise-0.1.13-py3-none-any.whl (124.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size vise-0.1.13.tar.gz (92.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page