Skip to main content

High-order force constants for the masses

Project description

hiPhive is a tool for efficiently extracting high-order force constants from atomistic simulations, most commonly density functional theory calculations. A detailed description of the functionality provided as well as an extensive tutorial can be found in the user guide. Complete examples of using hiphive for force constants extraction can be found in the hiphive-examples repository.

hiPhive is written in Python, which allows easy integration with countless first-principles codes and analysis tools accessible in Python, and allows for a simple and intuitive user interface. For example using the following snippet one can train a force constant potential:

cs = ClusterSpace(primitive_cell, cutoffs)
sc = StructureContainer(cs, list_of_training_structure)
opt = Optimizer(sc.get_fit_data())
opt.train()
fcp = ForceConstantPotential(cs, opt.parameters)

after which it can be used in various ways, e.g., for generating phonon dispersions, computing phonon lifetimes, or running molecular dynamics simulations.

For questions and help please use the hiphive discussion forum on matsci.org. hiPhive and its development are hosted on gitlab.

Installation

hiPhive can be installed via pip:

pip3 install hiphive

or via conda:

conda install -c conda-forge hiphive

hiPhive requires Python3 and invokes functionality from several external libraries including the atomic simulation environment, scikit-learn, spglib, SymPy, and trainstation. Please consult the installation section of the user guide for details.

Credits

hiPhive has been developed at the Department of Physics of Chalmers University of Technology (Gothenburg, Sweden) in the Condensed Matter and Materials Theory division.

When using hiPhive in your research please cite the following paper:

Fredrik Eriksson, Erik Fransson, and Paul Erhart
The Hiphive Package for the Extraction of High‐Order Force Constants by Machine Learning
Adv. Theory. Sim., 1800184 (2019)

Please consult the Credits page of the documentation for additional references.

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

hiphive-1.4.tar.gz (357.1 kB view details)

Uploaded Source

File details

Details for the file hiphive-1.4.tar.gz.

File metadata

  • Download URL: hiphive-1.4.tar.gz
  • Upload date:
  • Size: 357.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for hiphive-1.4.tar.gz
Algorithm Hash digest
SHA256 26ad6b55dfcb9cf486a081e1b252399350c982003abdd7cdf1b418370c00b824
MD5 7a52516f644d864cc339c4e2b5068ba9
BLAKE2b-256 6fa1db627f0dea49ce8ae34692f3852c5d13c6b6b1583876681ef87a0bf95a50

See more details on using hashes here.

Supported by

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