Skip to main content

hiPhive

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.

Metadata

Release files for hiPhive 1.1

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

Source distribution (sdist)

Source distribution for hiPhive 1.1
File Size Uploaded Provenance Actions
hiphive-1.1.tar.gz 1.5 MB Without provenance Details for hiphive-1.1.tar.gz

Release files / hiphive-1.1.tar.gz

Download URL hiphive-1.1.tar.gz
Size 1.5 MB
Tags Source
SHA-256 checksum
How to use checksums
f9dabe64efc2b0766792c64b1b9d8bd59e919aac30811a40e6f2b18fb0f287e1
BLAKE2b-256 checksum
How to use checksums
26e33686201dd3ee8530e2ee1d2421a4b7af22a6dfa164f20ae9a0ba24bd6c9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.5

Security for hiPhive 1.1

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.

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