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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file aiida_vasp-3.1.1.tar.gz.

File metadata

  • Download URL: aiida_vasp-3.1.1.tar.gz
  • Upload date:
  • Size: 12.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for aiida_vasp-3.1.1.tar.gz
Algorithm Hash digest
SHA256 64b3392efb4fa245b82ce66a4c6e7f241212d9d1095283a9ea75c0770db5c729
MD5 24abdaa068ac6d9039d8ce74b76b860c
BLAKE2b-256 873250d746ac3297991d64563ba565606a4304e3bd39ad7792c9f0e38b51fc6d

See more details on using hashes here.

File details

Details for the file aiida_vasp-3.1.1-py3-none-any.whl.

File metadata

  • Download URL: aiida_vasp-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for aiida_vasp-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e754d2ddb0af0b03bfffc6e1f6f2b13ba47905e38f5a7ea168d646e3b696b573
MD5 ea19047e0f582b199e01a9ae7e7f4aa0
BLAKE2b-256 b9105a89cc2edeb1efedbae62269d12ed6de29d854912e635769cb2f968e4420

See more details on using hashes here.

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