A plugin to AiiDA for running simulations with VASP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
aiida_vasp
doc
examples
ops
tests_pytest
utils
.coveragerc
.gitignore
.pre-commit-config.yaml
.prospector.yaml
.pylintrc
.style.yapf
.travis.yml
AUTHORS.md
CHANGELOG.md
LICENSE.txt
MANIFEST.in
README.rst
clean.sh
pylama.ini
pytest.ini
requirements-dev.txt
requirements-rtd.txt
run_ci_tests.sh
setup.json
setup.py
tox.ini

README.rst

AiiDA Vasp Plugin

https://travis-ci.org/aiida-vasp/aiida-vasp.svg?branch=develop Documentation Status https://coveralls.io/repos/github/aiida-vasp/aiida-vasp/badge.svg?branch=develop

This is a plugin to AiiDA to run calculations with the ab-initio program VASP.

Install and usage:

Install AiiDA

Install stable version of the plugin

::
$ pip install aiida-vasp

Install development version of the plugin

From the aiida-vasp folder use:

$ pip install .
# or
$ pip install -e . # <-- for plugin developers

Troubleshoot

To test wether the installation was successful use:

$ verdi calculation plugins

# example output:

## Pass as a further parameter one (or more) plugin names
## to get more details on a given plugin.
* codtools.cifcellcontents
* codtools.cifcodcheck
* codtools.cifcodnumbers
* codtools.ciffilter
* codtools.cifsplitprimitive
* quantumespresso.cp
* quantumespresso.pw
* quantumespresso.pwimmigrant
* simpleplugins.templatereplacer
* vasp.amn
* vasp.scf
* vasp.nscf
* vasp.vasp
* vasp.wannier

You should see vasp.* in the list

Configure the code

See aiida docs on how to set up computers and codes. Note that you need at least one computer configured and a VASP executable on it in order to use this plugin.

Using this plugin

For a tryout session, use the script run_vasp.py in the examples folder. Assuming you have already set up a code and computer, usage is as follows:

$ python run_vasp.py --help  # shows help message
$ # first time you need to import the potentials
$ python run_vasp.py --import-from=<path-to-potentials-folder> --queue=<your-compute-queue> <code> <computer>
  ... will take a while the first time due to importing potentials
$ # from  now on you can simply run
$ # python run_vasp.py --queue=<queue> <code> <computer>
$ verdi calculation list
  .. should contain a vasp calculation