Skip to main content

vasp_suite

vasp_suite is a package for generating input and submission files for vasp calculations

Installation via pip

Install vasp_suite using pip (if using a shared machine, add the --user argument after install)

pip install vasp_suite

Updating

Update the code using pip (if using a shared machine, add the --user argument after install)

pip install vasp_suite --upgrade

Installation with pip editable install

Only do this if you are developing (i.e. changing) the code.

Clone a copy of this repository, preferably while within a directory called git

mkdir -p git; cd git
git clone https://gitlab.com/chilton-group/vasp_suite

Navigate to the package directory

cd vasp_suite/packages

and install the package in editable mode (if using a shared machine, add the --user argument after install)

pip install -e .

When you're done developing (i.e. your changes have been merged to the master), or if you just want to use the current release version of the package, uninstall using pip

pip uninstall vasp_suite

and follow the Installation via pip instructions above.

Usage

The vasp_suite command line interface can be invoked with

vasp_suite -h

which prints a list of available subprograms.

Alternatively, the individual submodules can be imported into a python program or script as per usual.

Building a .whl file (Advanced)

Only do this if you are told to.

To build a copy of the vasp_suite .whl file, move to the package directory.

Now run

./build_binaries.sh

Then install the .whl file with pip (if using a shared machine, add the --user argument after install)

pip install dist/*.whl

Documentation

The documentation for this package is hosted by gitlab, and is automatically generated whenever new code is committed to the main branch. The automatic generation of this documentation relies on a common layout for comments and docstrings within the code, see contributing for more information.

Development

Before making changes to this repository, please follow the steps outlined in the Chilton group wiki.

Bugs

If you believe you have a bug, please check that you are using the most up to date version of the code.

If that does not fix the problem, please create an issue on GitLab detailing the following:

  • The commands you entered
  • The error message

Remember to simplify the problem as much as possible in order to provide a minimum working example, e.g. an example for a small molecule rather than one with 100000 atoms.

Then, look at the code, try and figure out what you think is wrong if possible, and include this in your issue.

Metadata

Release files for vasp-suite 1.16.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vasp-suite 1.16.0
File Size Uploaded Provenance Actions
vasp_suite-1.16.0.tar.gz 44.1 kB Without provenance Details for vasp_suite-1.16.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vasp-suite 1.16.0
File Interpreter ABI Platform Actions
vasp_suite-1.16.0-py3-none-any.whl Python 3 none any Details for vasp_suite-1.16.0-py3-none-any.whl

Total release size: 90.4 kB

Release files / vasp_suite-1.16.0.tar.gz

Download URL vasp_suite-1.16.0.tar.gz
Size 44.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4c9b16058a65012528fc8cd44a35b3fe8d2b0d5573d3c0bfd16a4aea0c7f58f4
BLAKE2b-256 checksum
How to use checksums
96a68e7cad6fe0320db657cd67249a48042af2368577e6930b5dbb3d328c963e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.22

Release files / vasp_suite-1.16.0-py3-none-any.whl

Download URL vasp_suite-1.16.0-py3-none-any.whl
Size 46.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a1e504f7a4672980e6ba987eba5a0bc765534b195c59c70e3ebe91cd751d5fb6
BLAKE2b-256 checksum
How to use checksums
013a9a086fda1ce9bdd1d68ae15ce7cc1e6f14c93005efe334b5d0b7ca8b2d68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.22

Security for vasp-suite 1.16.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.16.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page