Skip to main content

Package for handling io of vasp package in kumagai group at IMR, Tohoku university

Project description

PyPI - License PyPI - Python Version CircleCI

vise

VASP Integrated Supporting 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 or later 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.7 or higher

Vise depends largely on the following packages, which should be acknowledged sincerely,

  • 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

Detailed information is provided 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/cli         : command line interfaces
  /vise/input_set   : tools for generating VASP input files
  /vise/tests       : 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 the following paper.

"Insights into oxygen vacancies from high-throughput first-principles calculations"
Yu Kumagai, Naoki Tsunoda, Akira Takahashi, and Fumiyasu Oba
Phys. Rev. Materials 5, 123803 (2021)

Contact info

Yu Kumagai
yuuukuma@gmail.com

Tohoku University (Japan)

Project details


Download files

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

Source Distribution

vise-0.9.5.tar.gz (113.3 kB view details)

Uploaded Source

Built Distribution

vise-0.9.5-py3-none-any.whl (157.4 kB view details)

Uploaded Python 3

File details

Details for the file vise-0.9.5.tar.gz.

File metadata

  • Download URL: vise-0.9.5.tar.gz
  • Upload date:
  • Size: 113.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.28.1 setuptools/50.1.0 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.8.6

File hashes

Hashes for vise-0.9.5.tar.gz
Algorithm Hash digest
SHA256 a228e60b91510ac339dcd6826673f46205bd8d4b07f4b6f18913a75dac5632f2
MD5 26f7f7b2f87181e892050e9cb4dfca3d
BLAKE2b-256 7a97d6c0200fc97ecea6a9b707dd0323f6626da6b3a13cbe0f1ed320f05eea8f

See more details on using hashes here.

File details

Details for the file vise-0.9.5-py3-none-any.whl.

File metadata

  • Download URL: vise-0.9.5-py3-none-any.whl
  • Upload date:
  • Size: 157.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.28.1 setuptools/50.1.0 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.8.6

File hashes

Hashes for vise-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 170fd93f8c341ddd97ed7de85b1b918b14e42ae2cb014597ba532ff19ff3d955
MD5 895533f4648d5ddc5480746fdb5fede1
BLAKE2b-256 28b7cf608f50182d0dedea435da0ae493436e0f6f600d0cec48901549ba0253f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page