Free energy calculation using phonon gas model
Project description
pgm: A Python package for free energy calculations within the phonon gas model
Calculate thermodynamic properties of matter using phonon gas model(PGM)
Contributors
This repository is authored and maintained by Hongjin Wang and Jingyi Zhuang.
How to cite
The associated paper is published online here.
Please cite this article as:
Hongjin Wang, Jingyi Zhuang, Zhen Zhang, Qi Zhang, Renata M. Wentzcovitch, pgm: A Python package for free energy calculations within the phonon gas model, Computer Physics Communications (2023), Volume 291, 2023, 108845, https://doi.org/10.1016/j.cpc.2023.108845.
If you are unable to access the full text of this article, please contact the authors.
Installation
Install from PyPI
You can install the package directly from PyPI:
$ pip install phonon-gas-model
Manual install
To install the pgm
package, first clone the code repository using git
:
$ git clone https://github.com/MineralsCloud/pgm.git
After cloning the code repository, change to the code directory using cd
:
$ cd pgm
After changing to the code directory, install the required Python packages using pip
:
$ pip install -r requirements.txt
Finally, install the pgm package using pip
:
$ pip install .
See details in Installation of pgm.
How to use
Here we provide two examples inside the example folder. One is CaSiO₃, and one is B8-FeO.
For the case of CaSiO₃, simply run the following commands from the root path of the package:
$ cd examples/casio3
$ pgm run casio3.yaml
and for another case, B8-FeO,
run the following commands from the root path of the package:
$ cd examples/feo
$ pgm run feo.yaml
See details Command Line Tool of pgm.
Use your own example
First, you need to prepare a set of phonon calculations calculated at different temperatures.
Convert them as standard qha input files(for now use input converter in qha pkg), and put the input files like in the case of CaSiO₃ or B8-FeO
Compose your own settings.yaml
file, enjoy.
Details will be provide shortly.
Documentation
See GitHub pages of pgm.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for phonon_gas_model-1.0.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db147832916b8ebe8421982e9651f1cc6a61bafcbde30fc95f39e0cb6254c4b4 |
|
MD5 | 7d70f449fcdf9d329ea512fe51cb1342 |
|
BLAKE2b-256 | e89d381f1889e67526b0ee870e84c7b30c0286a55e56d99e5b912daa5f90d266 |