Skip to main content

AiiDA plugin for running VASP calculations and workflows.

Project description

Release

Stable version PyPI - Status Supported Python versions

Build

Build status Test coverage Documentation Status

Stats

PyPI - Downloads/month GitHub commit activity Zenodo DOI

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

Please have a look at the AiiDA-VASP documentation for instructions on how to install and use the plugin.

Installing the plugin

  1. If you are already using AiiDA, simply activate the virtual environment associated with it, here assumed to be located in ~/env/aiida-vasp:

    $ source ~/env/aiida-vasp/bin/activate
  2. Otherwise, set up a new virtual environment:

    $ python -m venv ~/env/aiida-vasp
  3. And then enable the newly installed virtual environment:

    $ source ~/env/aiida-vasp/bin/activate
  4. Install the AiiDA-VASP plugin (and AiiDA if that is not already installed):

    $ (aiida-vasp) pip install aiida-vasp

If you need to install the compatibility release of AiiDA-VASP which works with AiiDA 1.6.4 you should instead install the plugin using pip install aiida-vasp=2.2, but this is not recommended and only mentioned for legacy support. For the legacy version you also most likely have to run reentry scan -r aiida after installing the plugin.

This will automatically install the AiiDA python package(s) as well as any other dependencies of the plugin and register all the plugin classes with AiiDA.

Please consider that AiiDA have prerequisite that needs to be installed and ensured working. The steps above will not take care of this for you. Please consult AiiDA prerequisites and follow the instructions therein.

Support

The development, maintenance and use of this plugin is considered a community effort. In order to facilitate for the community to contribute, we have established a space on Matrix that users can use to communicate. We encourage users to help each other. In addition, the development team is present in the space and users are free to ask. First consult the documentation of both AiiDA-VASP documentation and AiiDA documentation and also consider that the developers are not paid for this work. Please respect potential lead times in getting answers and be polite.

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

aiida_vasp-3.1.1.tar.gz (12.6 MB view hashes)

Uploaded Source

Built Distribution

aiida_vasp-3.1.1-py3-none-any.whl (12.1 MB view hashes)

Uploaded Python 3

Supported by

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