Skip to main content

A simplified way to get Gibbs free energy from Vasp calculations

Project description

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!

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

vaspgibbs-0.2.3.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vaspgibbs-0.2.3-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file vaspgibbs-0.2.3.tar.gz.

File metadata

  • Download URL: vaspgibbs-0.2.3.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vaspgibbs-0.2.3.tar.gz
Algorithm Hash digest
SHA256 a6fc9fbe653ca21fd5e348fcf022d842d1b612e2ecbdf90a0c463e9447ce7102
MD5 2475e54031126e1693cc637b2b4d558f
BLAKE2b-256 1d215cf3f03f81e738b6b2c513dbfa0e1819c90978a51db6258f061f93dd7aa2

See more details on using hashes here.

Provenance

The following attestation bundles were made for vaspgibbs-0.2.3.tar.gz:

Publisher: publish-to-pypi.yml on ftherrien/VaspGibbs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vaspgibbs-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: vaspgibbs-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vaspgibbs-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8af4027c3d6a22af35ba7fee81d4b2d0d629be9d73525a649c4913e3c4494ce4
MD5 855208382024da3c8517c40a5b598384
BLAKE2b-256 ec9e72e86c07b2b9ad893e8395e07ded564338d194c1e7d112a056dba00dea2a

See more details on using hashes here.

Provenance

The following attestation bundles were made for vaspgibbs-0.2.3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on ftherrien/VaspGibbs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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