Skip to main content

VaspGibbs


DOI PyPI

Installation

pip install VaspGibbs

Usage

In a folder with a finished vasp calculation, run

vasp_gibbs

vasp_gibbs will rerun Vasp to obtain vibration modes and output the gibbs free energy of your system.

Use -o (only) or -t(top) to specify a set of atoms for which to calculate vibration modes. Examples:

  • -o C O would only compute vibration modes associated with C and O keeping all other atoms fixed.
  • -o 0 2 5 would compute vibration modes associated with the first, third and sixth atoms in the POSCAR keeping all other atoms fixed. (Counts from 0)
  • -t 10 would compute vibration modes associated with the first 10 atoms starting from the top of the unit cell along the c axis.

This can be useful when computing free energy differences between systems where one part of the system does not change, e.g. adsorption free energies.

To run vasp in parallel call:

vasp_gibbs -n [number of proc] -m [mpi executable] -v [vasp executable]

By default srun and vasp_std are used.

VaspGibbs will automatically compute the moment of inertia and symmetry of your molecule and compute rotational and translational contributions if you specify that the system is a molecule with the -m flag.

The temperature and pressure can be set using the -T and -P flags.

Output

All outputs can be found in the VaspGibbs.md file. It contains the following information:

Rotational properties

Property Value
Sigma x
P. axes
I~1 x eV/THz^2
I~2 x eV/THz^2
I~3 x eV/THz^2

Energy corrections

Type Z E (eV) S (eV/K) F (eV)
ZPE N/A x N/A N/A
Electronic x x x x
Vibrational x x x x
Rotational x x x x
Translational x x x x

Thermodynamic Quantities

Quantity Value
Enthalpy x eV
Entropy x eV/K
Gibbs Free Energy x eV
G - E_dft x eV
TS x eV

Online Ressources

Citation

@software{therrien2023vaspgibbs,
  author       = {Félix Therrien},
  title        = {{VaspGibbs: A simple way to obtain Gibbs free 
                   energy from Vasp calculations}},
  month        = apr,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {v0.2.1},
  doi          = {10.5281/zenodo.7874413},
  url          = {https://doi.org/10.5281/zenodo.7874413}
}

Under development

Results have been checked with J. Phys. Chem. C 2013, 117, 49. More validation needs to be done; use with care.

Next steps: more testing, add to pypi, PV term for solids with Murnaghan equation, hindered translator and rotor?

Let me know if you would like new features to be added!

Metadata

Release files for VaspGibbs 0.2.3

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

Source distribution (sdist)

Source distribution for VaspGibbs 0.2.3
File Size Uploaded
vaspgibbs-0.2.3.tar.gz 9.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for VaspGibbs 0.2.3
File Interpreter ABI Platform
vaspgibbs-0.2.3-py3-none-any.whl Python 3 none any Details

Total release size: 19.4 kB

Release files / vaspgibbs-0.2.3.tar.gz

Download URL vaspgibbs-0.2.3.tar.gz
Size 9.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a6fc9fbe653ca21fd5e348fcf022d842d1b612e2ecbdf90a0c463e9447ce7102
BLAKE2b-256 checksum
How to use checksums
1d215cf3f03f81e738b6b2c513dbfa0e1819c90978a51db6258f061f93dd7aa2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 6, 2025.

Transparency log

Release files / vaspgibbs-0.2.3-py3-none-any.whl

Download URL vaspgibbs-0.2.3-py3-none-any.whl
Size 10.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8af4027c3d6a22af35ba7fee81d4b2d0d629be9d73525a649c4913e3c4494ce4
BLAKE2b-256 checksum
How to use checksums
ec9e72e86c07b2b9ad893e8395e07ded564338d194c1e7d112a056dba00dea2a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 6, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.3 This release

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

1 release file

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