calphy
calphy(pronounced cal-phee) is a Python library and command line tool for calculation of free energies. It uses LAMMPS as the molecular dynamics driver to enable calculation of free energies using thermodynamic integration in a completely automated and efficient manner. The various methods that calphy can perform are:
and
for both solid and liquid phases at the given thermodynamic conditions using non-equilibrium Hamiltonian interpolation.
and
, temperature dependence of Gibbs and Helmholtz free energies using the reversible scaling approach.
- Calculation of solid-solid or solid-liquid phase transition temperatures.
- Calculation of solid-liquid coexistence lines
over a wide pressure range from a single known coexistence point using dynamic Clausius-Clapeyron integration.
- Calculation of specific heat
as a function of temperature.
- Calculation of
and
for multicomponent systems using alchemical transformations.
- Upsampling calculations.
Calphy works with all interatomic potentials implemented in LAMMPS and can obtain reliable results with low error bars in as low as 50 ps of simulation time with less than 3000 atoms. More information about the methods in calphy can be found in the associated publication.
Installation, examples and documentation
-
Read the
calphyinstallation instructions and documentation including examples here. -
For a description of the methods and algorithms implemented in
calphy, please see the associated publication. -
For a set of examples presented in the
calphypublication, please see here.
Citing calphy
If you find calphy useful, please consider citing:
Menon, Sarath, Yury Lysogorskiy, Jutta Rogal, and Ralf Drautz.
“Automated Free Energy Calculation from Atomistic Simulations.”
Physical Review Materials 5(10), 2021
DOI: 10.1103/PhysRevMaterials.5.103801
Download bibtex here
License
calphy is published and distributed under the Academic Software Licence v1.0 (ASL), a reciprocal licence whose core terms match the GNU GPLv2 but which permits academic non-commercial use only. It is an available-source, not an open-source, licence. See LICENSE for the full terms.
If you intend to use calphy commercially, you need a separate commercial licence. Please contact sarath.menon@ruhr-uni-bochum.de to enquire about commercial use rights.
Releases up to and including 2.0.1 were distributed under a split ASL / BSD-3-Clause licence (and earlier releases under the GNU GPL). Those grants continue to apply to the versions they were published with; from 2.1.0 onwards calphy is ASL only.
Note that calphy drives LAMMPS, which is licensed separately under the GNU GPLv2. calphy does not include LAMMPS.
2 maintainers
Metadata
2 maintainers
Release files for calphy 2.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| calphy-2.3.1.tar.gz | 278.4 kB | With provenance | Details for calphy-2.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| calphy-2.3.1-py3-none-any.whl | Python 3 | none | any | Details for calphy-2.3.1-py3-none-any.whl |
Total release size: 504.8 kB
Release files / calphy-2.3.1.tar.gz
| Download URL | calphy-2.3.1.tar.gz |
|---|---|
| Size | 278.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
710d1d3b7e1a3e312dc90418f97b7ca447ce893e17e10547b03d71850132200c
|
|
BLAKE2b-256 checksum How to use checksums |
7034ccea09f4e18d6391825363b913679b75be4922b76adde455e96b9b89dd29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 7, 2026.
Transparency logRelease files / calphy-2.3.1-py3-none-any.whl
| Download URL | calphy-2.3.1-py3-none-any.whl |
|---|---|
| Size | 226.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9066a7da3ffeb44e4826b24c2daf4565eb636a4b2cfafb6974721d38e78d6ba1
|
|
BLAKE2b-256 checksum How to use checksums |
8f7937e97eef878621c2eeb15a053edb82a75f388b349cca25004fb8924a8323
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Nov 7, 2026.
Transparency logSecurity for calphy 2.3.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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for calphy-2.3.1.tar.gz
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 Nov 7, 2026.
Transparency logA 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.
